Remove toctree from README.rst files
The README.rst
files are used on PyPI, and they should only contain standard reStructuredText markup and directives. At the moment some of the modules (such as the timesheet module) use the toctree
directive in the doc/index.rst
file which is used as the README.rst
file, although it may seem to work it is not supported.
To fix this we could move the doc/index.rst
file to README.rst
, and remove any toctree
and other Sphinx specific markup from it. Then create a doc/index.rst
file that contains for example:
.. include:: ../README.rst
.. toctree::
:maxdepth: 1
user_application