5

私は単一の .py モジュールしか持たない Python ライブラリに取り組んでおり、docstring からそのドキュメントを生成しようとしています。Sphinx をセットアップして、spinx-quickstart スクリプトを実行しましたが、実行しようとすると (docs ディレクトリで)

sphinx-apidoc ../cffiwrap.py -o .

しかし、それはただ言う：

../cffiwrap.py is not a directory.

単一のファイルを autodoc する他の Sphinx スクリプトはありますか? 実行することだけを考え..ましたが、テストディレクトリに実行され、単体テストからドキュメントを生成しようとすると考えました...

4

2 に答える 2

0

この短いブログ投稿は、単一モジュールの自動 API ドキュメントを生成する別の方法を示しているようです。利便性と持続性のためにここにコピー:

モジュールと同じディレクトリにファイルを配置しconf.pyます。

import os
import sys

# enable autodoc to load local modules
sys.path.insert(0, os.path.abspath("."))

project = "<project>"
copyright = "year, author"
author = "author"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
templates_path = ["_templates"]
html_theme = "alabaster"
html_static_path = ["_static"]
intersphinx_mapping = {
    "python": ("https://docs.python.org/3", None)
}
html_theme_options = {"nosidebar": True}

index.rstこれを横に追加します

<project>
=========

.. automodule:: <project>
   :members:

<project>最後に、モジュール名に置き換えて、pip install sphinx次を実行します。

sphinx-build -b html . _build
于 2020-02-12T12:58:03.350 に答える