Проблема с документом PyCharm проекта со Sphinx - PullRequest
Новая
       61

Проблема с документом PyCharm проекта со Sphinx

0 голосов
/ 28 сентября 2019

Я хочу сделать документацию моего проекта pycharm.Я сделал в своем каталоге проекта («модель») каталог документов.Я установил sphinx и с помощью sphinx-quickstart сделал все необходимые файлы.Затем я отредактировал "conf.py".Я раскомментировал: 

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

И добавил: 

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'sphinx.ext.napoleon'
]

В проекте "модель" у меня есть 4 файла (file1.py, file2.py, file3.py и file4.py) поэтому я отредактировал index.rst так: 

File1
=====================================

.. toctree:: model.file1
   :maxdepth: 2
   :caption: Contents:


File2
=====================================

.. toctree:: model.file2
   :maxdepth: 2
   :caption: Contents:


File3
=====================================

.. toctree:: model.file3
   :maxdepth: 2
   :caption: Contents:


File4
=====================================

.. toctree:: model.file4
   :maxdepth: 2
   :caption: Contents:

Но после "make html" он дает мне error: WARNING: toctree contains reference to nonexisting document 'model.file1'

Знаете ли вы, как сделать эту документацию?Как сделать из него pdf файл?

1 Ответ

1 голос
/ 29 сентября 2019

Директива toctree не делает то, что вы думаете .В частности, это должен быть файл reStructuredText, а не файл Python.

Вместо этого, если вы хотите документировать строки документации в пакете Python и его модулях, вам следует прочитать о autodoc и sphinx-apidoc, и убедитесь, что у вас есть __init.py__ внутри model, так что это пакет Python.

Наконец, весьма необычно размещать файлы reStructuredText внутри пакетов, где рекомендуется размещать только кодвнутри пакета и поместите документацию снаружи.

...