Python: Как я могу определить в sphinx, какие файлы и каталоги .rst следует использовать?

Как определить в sphinx, какие файлы и каталоги .rst следует использовать?

Я хочу включить автоматический генератор документации в мой скрипт тестирования /сборки /документации. sphinx-quickstart был выполнен в моей рабочей области и создал файл index.rst. Поскольку sphinx использует реструктурированные текстовые файлы для документации, я прошел по рабочей области и создал их вручную с помощью sphinx-autogen . Это привело к файлу tasks.rst (см. Ниже).

Когда я использую 'make html', я получаю несколько предупреждений:

  

ПРЕДУПРЕЖДЕНИЕ : недопустимая подпись для автомодуля (u'tasks /add_to_config ')

     

ПРЕДУПРЕЖДЕНИЕ : autodoc не может импортировать /найти модуль 'tasks.add_to_config', сообщается об ошибке: «Нет модуля с именем wl_build.tasks». >      

ПРЕДУПРЕЖДЕНИЕ : не знаю, какой модуль импортировать для автодокументирования u'tasks /add_to_config '(попробуйте разместить в документе директиву module или currentmodule или дать явное имя модуля )

     

...

Мой index.rst

Welcome to build's documentation!
====================================

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks/add_to_config
   :members:

.. automodule:: tasks/build_egg
   :members:   

tasks.rst

tasks Package
=============

:mod:`tasks` Package
--------------------

.. automodule:: tasks.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`add_to_config` Module
---------------------------

.. automodule:: tasks.add_to_config
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`build_egg` Module
-----------------------

.. automodule:: tasks.build_egg
    :members:
    :undoc-members:
    :show-inheritance:
4 голоса | спросил Jon 30 +04002012-10-30T12:22:52+04:00312012bEurope/MoscowTue, 30 Oct 2012 12:22:52 +0400 2012, 12:22:52

1 ответ


0

Попробуйте заменить символы / в файле index.rst точками (.)

вот так:

Welcome to build's documentation!
====================================

Contents:

.. toctree::
   :maxdepth: 2

.. automodule:: tasks.add_to_config
   :members:

.. automodule:: tasks.build_egg
   :members:  

Посмотрите, поможет ли это.

Если Sphinx по-прежнему не может найти код для документирования, вам, вероятно, потребуется изменить PYTHONPATH или изменить sys.path в вашем файле conf.py, чтобы помочь Sphinx найти то, что он ищет.

ответил Kevin Horn 7 FriEurope/Moscow2012-12-07T20:26:28+04:00Europe/Moscow12bEurope/MoscowFri, 07 Dec 2012 20:26:28 +0400 2012, 20:26:28

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132