python - How to get Read the Docs to generate py-modindex.html? -
i'm trying read docs generate py-modindex.html file. research this question lead me following setup:
setup.pyin project directory has following contents, minimum neededpytestwork , haven't been changed since got part of project working:import setuptools setuptools.setup( name='polygons', packages=setuptools.find_packages(), )docs/requirements.txtcontains single line:sphinx-autodoc-annotationthe read docs repository url points github repository.
- the rtd setting "install project inside virtualenv using setup.py install" checked.
- the rtd setting "requirements file" points
docs/requirements.txt.
the "module index" link gets included in index.html, py-modindex.html file missing.
my understanding virtualenv setting above, rtd use setup.py file install project sphinx can read documentation found in python docstrings. i'm using function annotations , sphyinx-autodoc-annotation make use of when creating built docs files. of works splendidly on local machine when run make html while in docs folder. i'm trying work on read docs.
note: exercise i'm going through understand before apply real project, polygons project placeholder for.
Comments
Post a Comment