So dokumentieren Sie Python-Pakete mit Sphinx
Ich versuche, ein Paket in Python zu dokumentieren. Im Moment habe ich folgende Verzeichnisstruktur:
.
└── project
├── _build
│ ├── doctrees
│ └── html
│ ├── _sources
│ └── _static
├── conf.py
├── index.rst
├── __init__.py
├── make.bat
├── Makefile
├── mod1
│ ├── foo.py
│ └── __init__.py
├── mod2
│ ├── bar.py
│ └── __init__.py
├── _static
└── _templates
Dieser Baum ist das Ergebnis des Brennens vonsphinx-quickstart
. Imconf.py
Ich habe nicht kommentiertsys.path.insert(0, os.path.abspath('.'))
und ich habeextensions = ['sphinx.ext.autodoc']
.
Meineindex.rst
ist:
.. FooBar documentation master file, created by
sphinx-quickstart on Thu Aug 28 14:22:57 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to FooBar's documentation!
==================================
Contents:
.. toctree::
:maxdepth: 2
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
In allen__init__.py
hab ich einen docstring und das selbe geht an die modulefoo.py
undbar.py
. Allerdings beim Laufenmake html
In dem Projekt sehe ich keine der Dokumente.