Sphinx生成空文档 [英] Sphinx generates empty documentation

问题描述

我试图使用Sphinx为我的项目生成文档，但输出文档不包含我的任何类。我做错了什么？以下是我用来生成文档的命令：

> ls
Aplikacja.py*   Baza.py            doc/                 EkranLogowania.py     EkranRejestracji.py  InterfejsWWW.py  RequestHandler.py    _static/     util.py
BazaLoginow.py  BladWalidiacji.py  EkranBledu.py        EkranMenuGlownego.py  GodzinyZajec.py      Makefile         res/                 _templates/  Zajecia.py
BazaPlanow.py   db/                EkranEdycjiZajec.py  EkranPlanu.py         HTTPServer.py        Plan.py          SesjaUzytkownika.py  USOSApi.py
> sphinx-quickstart
Welcome to the Sphinx 1.1.3 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]:

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/N) [n]: n

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: usos-python
> Author name(s): d33tah

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 0.1
> Project release [0.1]:

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]: n

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/N) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]:
> coverage: checks for documentation coverage (y/N) [n]:
> pngmath: include math, rendered as PNG images (y/N) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/N) [n]:
> ifconfig: conditional inclusion of content based on config values (y/N) [n]:
> viewcode: include links to the source code of documented Python objects (y/N) [n]:

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (Y/n) [y]: y
> Create Windows command file? (Y/n) [y]: n

Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.

Finished: An initial directory structure has been created.

You should now populate your master file ./index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

> make html
sphinx-build -b html -d _build/doctrees   . _build/html
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.

Build finished. The HTML pages are in _build/html.
> find _build/html
_build/html
_build/html/search.html
_build/html/index.html
_build/html/_static
_build/html/_static/file.png
_build/html/_static/comment-bright.png
_build/html/_static/sidebar.js
_build/html/_static/minus.png
_build/html/_static/ajax-loader.gif
_build/html/_static/jquery.js
_build/html/_static/pygments.css
_build/html/_static/comment.png
_build/html/_static/up.png
_build/html/_static/underscore.js
_build/html/_static/down-pressed.png
_build/html/_static/down.png
_build/html/_static/doctools.js
_build/html/_static/websupport.js
_build/html/_static/default.css
_build/html/_static/comment-close.png
_build/html/_static/up-pressed.png
_build/html/_static/searchtools.js
_build/html/_static/basic.css
_build/html/_static/plus.png
_build/html/objects.inv
_build/html/genindex.html
_build/html/_sources
_build/html/_sources/index.txt
_build/html/.buildinfo
_build/html/searchindex.js

推荐答案

您需要在您的项目上运行sphinx-apidoc命令，以自动生成与您的Python模块对应的.rst文件。然后，autodoc扩展将使用它们来实际生成文档。

这篇关于Sphinx生成空文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！