プロジェクト API¶
-
class
sphinx.project.
Project
(srcdir, source_suffix)[ソース]¶ A project is source code set of Sphinx document.
-
discover
(exclude_paths=[])[ソース]¶ Find all document files in the source directory and put them in
docnames
.
-
doc2path
(docname, basedir=True)[ソース]¶ ドキュメント名に関連するファイル名を返します。
If basedir is True, return as an absolute path. Else, return as a relative path to the source directory.
-
path2doc
(filename)[ソース]¶ Return the docname for the filename if the file is document.
filenameは絶対パスもしくは、ソースディレクトリからの相対パスで指定する必要があります。
-
docnames
¶ The name of documents belongs to this project.
-
source_suffix
¶ source_suffix. Same as
source_suffix
.
-
srcdir
¶ ソースディレクトリ。
-