Я не могу сделать документацию по сфинксу - PullRequest
Новая
       46

Я не могу сделать документацию по сфинксу

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

Я новичок в документации по sphinx и пытаюсь сделать это один день безуспешно.У меня есть каталог "каталог" с двумя подкаталогами "проект" (это папка с моим проектом, которая содержит 4 модуля Python (file1.py, file2.py, file3.py, file4.py) и "документы", где с использованием sphinx-quickstart Я сделал все необходимые файлы. Затем я отредактировал conf.py uncomment 

import os
import sys
sys.path.insert(0, os.path.abspath('..')) # two dots are good here for my situation?

Я также отредактировал index.rst: 

Welcome to Project's documentation!
=====================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

и с командой sphinx-apidoc -o . ../project/ я сделал проект.rst и modules.rst.

Когда я в docs dir и пытаюсь "сделать html", это выдает мне следующую ошибку: 

WARNING: autodoc: failed to import module 'file2' from module 'project'; the following exception was raised:
No module named 'file1'
WARNING: autodoc: failed to import module 'file3' from module 'project'; the following exception was raised:
No module named 'file1'
WARNING: autodoc: failed to import module 'file4' from module 'project'; the following exception was raised:
No module named 'file1'
WARNING: autodoc: failed to import module 'file1' from module 'project'; the following exception was raised:
No module named 'file1'
WARNING: autodoc: failed to import module 'project'; the following exception was raised:
No module named 'file1'

У меня также __init__.pyфайл, который выглядит так: 

from file1 import *
from file2 import *
from file3 import *
from file4 import *

Может ли кто-нибудь помочь мне с моей проблемой?

modules.rst: 

project
=========

.. toctree::
   :maxdepth: 4

   project

project.rst: 

project package
=================

Submodules
----------

project.file1 module
--------------------------

.. automodule:: project.file1
    :members:
    :undoc-members:
    :show-inheritance:

project.file2
------------------------------

.. automodule:: project.file2
    :members:
    :undoc-members:
    :show-inheritance:

project.file3 module
----------------------------

.. automodule:: project.file3
    :members:
    :undoc-members:
    :show-inheritance:

project.file4 module
----------------------

.. automodule:: project.file4
    :members:
    :undoc-members:
    :show-inheritance:

Module contents
---------------

.. automodule:: project
    :members:
    :undoc-members:
    :show-inheritance:
...