Я пытаюсь автоматически сгенерировать документацию по проекту на Python, используя sphinx. Однако я не могу сгенерировать документацию из doscstrings. Ниже приведены шаги, которые я предпринял
Моя структура каталогов выглядит как
В каталоге документов я выполняю
sphinx-quickstart
Я отвечаю
Separate source and build directories (y/n) [n]: y
Остальные стандартные значения по умолчанию. Теперь документы выглядят примерно так:
В файле conf.py внутри документов я делаю следующие правки
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
extensions = ['sphinx.ext.autodoc','sphinx.ext.todo','sphinx.ext.coverage']
Затем вКаталог документов я запускаю
sphinx-apidoc -f -o source/ ../axolotl/
После этого я запускаю
make html
в каталоге документов, и я получаю следующие журналы
Мой index.html в папке сборки выглядит примерно так
Без списков подпапок
В другом дополнительном файле modules.html перечислены папки, но он не генерирует строки документации из документации.
Я ссылался на различные ссылки на stackoverflowи блоги с прошлых двух дней, пожалуйста, кто-то может указать, где я иду не так?
Другие детали:
- Я работаю на MacOS
- Я создал среду с использованием Conda, в которой установлены sphinx и другие необходимые модули
**** Ранее проблема устранялась путем исправленияпуть sys, предложенный @mzn и установкой n необходимых модулей **** ** Проблема 2: Index.rst выглядит следующим образом ** ..
axolotl documentation master file, created by
sphinx-quickstart on Wed Nov 6 18:45:01 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to axolotl's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Index.html выглядит как