Документация sphinx не получает docstrings/modules
Hej! :)
Я хочу создать документацию моего проекта django и использую sphinx. Я написал docstring для каждой функции и класса, которые я хочу интегрировать автоматически.
Я следовал этому руководству и все запустилось. Моя документация не дает мне информацию о docstring, но myProject.app.views module
в качестве вывода (для каждого файла в моем проекте), но нет информации о том, что находится в файле.
Мой app.rst выглядит так:
biodata.stakeholders package
============================
Subpackages
-----------
.. toctree::
:maxdepth: 4
biodata.stakeholders.migrations
biodata.stakeholders.templatetags
Submodules
---------
biodata.stakeholders.admin module
---------------------------------
.. automodule:: biodata.stakeholders.admin
:members:
:undoc-members:
:show-inheritance:
biodata.stakeholders.models module
----------------------------------
.. automodule:: biodata.stakeholders.models
:members:
:undoc-members:
:show-inheritance:
# index.rst
.. toctree::
:maxdepth: 2
:caption: Contents:
.. automodule:: Run
:members:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
<
При запуске make html
я получаю
WARNING: autodoc: failed to import module 'stakeholders.admin' from module 'biodata'; the following exception was raised:
No module named 'biodata.stakeholders'
<
<