autodoc¶
Note
For Sphinx (actually, the Python interpreter that executes Sphinx) to find your module, it must be importable. That means that the module or the package must be in one of the directories on sys.path – adapt your sys.path in the configuration file accordingly.
Warning
autodoc imports the modules to be documented. If any modules have side effects on import, these will be executed by autodoc when sphinx-build is run.
If you document scripts (as opposed to library modules), make sure their main routine is protected by a if name == ‘main’ condition.
environment¶
import os
home_dir = os.path.expanduser('~')
work_dir = f'{home_dir}/sphinx_demo'
os.chdir(work_dir)
!pwd
/home/runner/sphinx_demo
configure¶
1. conf.py 수정¶
autodoc extension 추가
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
code 경로 추가 (아래는 sphinx library)
import os
import sys
sys.path.insert(0, os.path.abspath('~/sph/.venv/lib/python3.10/site-packages/sphinx/'))
2. apidoc¶
!pdm run sphinx-apidoc -o ./docs .venv/lib/python3.10/site-packages/docutils
Creating file ./docs/docutils.rst.
Creating file ./docs/docutils.languages.rst.
Creating file ./docs/docutils.parsers.rst.
Creating file ./docs/docutils.parsers.rst.rst.
Creating file ./docs/docutils.parsers.rst.directives.rst.
Creating file ./docs/docutils.parsers.rst.languages.rst.
Creating file ./docs/docutils.readers.rst.
Creating file ./docs/docutils.transforms.rst.
Creating file ./docs/docutils.utils.rst.
Creating file ./docs/docutils.utils.math.rst.
Creating file ./docs/docutils.writers.rst.
Creating file ./docs/docutils.writers.html4css1.rst.
Creating file ./docs/docutils.writers.html5_polyglot.rst.
Creating file ./docs/docutils.writers.latex2e.rst.
Creating file ./docs/docutils.writers.odf_odt.rst.
Creating file ./docs/docutils.writers.pep_html.rst.
Creating file ./docs/docutils.writers.s5_html.rst.
Creating file ./docs/docutils.writers.xetex.rst.
Creating file ./docs/modules.rst.
!tree ./docs -L 1
./docs
├── Makefile
├── _build
├── _static
├── _templates
├── conf.py
├── docutils.languages.rst
├── docutils.parsers.rst
├── docutils.parsers.rst.directives.rst
├── docutils.parsers.rst.languages.rst
├── docutils.parsers.rst.rst
├── docutils.readers.rst
├── docutils.rst
├── docutils.transforms.rst
├── docutils.utils.math.rst
├── docutils.utils.rst
├── docutils.writers.html4css1.rst
├── docutils.writers.html5_polyglot.rst
├── docutils.writers.latex2e.rst
├── docutils.writers.odf_odt.rst
├── docutils.writers.pep_html.rst
├── docutils.writers.rst
├── docutils.writers.s5_html.rst
├── docutils.writers.xetex.rst
├── index.rst
├── make.bat
└── modules.rst
3 directories, 23 files
3. build¶
!pdm run sphinx-build docs/ docs/_build/html
Show code cell output
Running Sphinx v7.0.1
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 19 added, 0 changed, 0 removed
reading sources... [ 5%] docutils
reading sources... [ 10%] docutils.languages
reading sources... [ 15%] docutils.parsers
reading sources... [ 21%] docutils.parsers.rst
reading sources... [ 26%] docutils.parsers.rst.directives
reading sources... [ 31%] docutils.parsers.rst.languages
reading sources... [ 36%] docutils.readers
reading sources... [ 42%] docutils.transforms
reading sources... [ 47%] docutils.utils
reading sources... [ 52%] docutils.utils.math
reading sources... [ 57%] docutils.writers
reading sources... [ 63%] docutils.writers.html4css1
reading sources... [ 68%] docutils.writers.html5_polyglot
reading sources... [ 73%] docutils.writers.latex2e
reading sources... [ 78%] docutils.writers.odf_odt
reading sources... [ 84%] docutils.writers.pep_html
reading sources... [ 89%] docutils.writers.s5_html
reading sources... [ 94%] docutils.writers.xetex
reading sources... [100%] modules
/home/runner/sphinx_demo/docs/docutils.rst:23: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.core
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:31: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.examples
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:39: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.frontend
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:47: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.io
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:55: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.nodes
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:63: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.statemachine
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.rst:71: ERROR: Unknown directive type "automodule".
.. automodule:: docutils
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.af
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.ar
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.ca
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.cs
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.da
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.de
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:58: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.en
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:66: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.eo
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:74: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.es
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:82: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.fa
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:90: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.fi
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:98: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.fr
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:106: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.gl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:114: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.he
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:122: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.it
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:130: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.ja
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:138: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.ko
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:146: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.lt
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:154: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.lv
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:162: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.nl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:170: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.pl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:178: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.pt_br
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:186: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.ru
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:194: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.sk
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:202: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.sv
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:210: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.uk
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:218: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.zh_cn
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:226: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages.zh_tw
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.languages.rst:234: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.languages
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst:7: WARNING: duplicated entry found in toctree: docutils.parsers
/home/runner/sphinx_demo/docs/docutils.parsers.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.commonmark_wrapper
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.null
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.recommonmark_wrapper
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.rst:19: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.roles
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.rst:27: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.states
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.rst:35: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.tableparser
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.rst:43: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.admonitions
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.body
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.html
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.images
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.misc
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.parts
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:58: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.references
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:66: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives.tables
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.directives.rst:74: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.directives
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.af
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.ar
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.ca
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.cs
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.da
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.de
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:58: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.en
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:66: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.eo
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:74: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.es
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:82: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.fa
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:90: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.fi
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:98: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.fr
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:106: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.gl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:114: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.he
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:122: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.it
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:130: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.ja
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:138: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.ko
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:146: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.lt
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:154: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.lv
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:162: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.nl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:170: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.pl
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:178: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.pt_br
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:186: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.ru
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:194: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.sk
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:202: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.sv
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:210: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.uk
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:218: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.zh_cn
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:226: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages.zh_tw
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.parsers.rst.languages.rst:234: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.parsers.rst.languages
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.readers.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.readers.doctree
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.readers.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.readers.pep
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.readers.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.readers.standalone
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.readers.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.readers
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.components
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.frontmatter
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.misc
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.parts
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.peps
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.references
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:58: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.universal
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:66: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms.writer_aux
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.transforms.rst:74: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.transforms
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.code_analyzer
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.error_reporting
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.punctuation_chars
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.roman
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.smartquotes
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:58: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.urischemes
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.rst:66: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math.latex2mathml
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math.math2html
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math.tex2mathml_extern
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:34: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math.tex2unichar
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:42: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math.unichar2tex
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.utils.math.rst:50: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.utils.math
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.rst:24: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.docutils_xml
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.rst:32: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.manpage
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.rst:40: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.null
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.rst:48: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.pseudoxml
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.rst:56: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.html4css1.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.html4css1
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.html5_polyglot.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.html5_polyglot
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.latex2e.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.latex2e
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.odf_odt.rst:10: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.odf_odt.prepstyles
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.odf_odt.rst:18: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.odf_odt.pygmentsformatter
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.odf_odt.rst:26: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.odf_odt
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.pep_html.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.pep_html
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.s5_html.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.s5_html
:members:
:undoc-members:
:show-inheritance:
/home/runner/sphinx_demo/docs/docutils.writers.xetex.rst:7: ERROR: Unknown directive type "automodule".
.. automodule:: docutils.writers.xetex
:members:
:undoc-members:
:show-inheritance:
looking for now-outdated files... none found
pickling environment...
done
checking consistency... /home/runner/sphinx_demo/docs/docutils.parsers.rst.rst: WARNING: document isn't included in any toctree
/home/runner/sphinx_demo/docs/modules.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [ 5%] docutils
writing output... [ 10%] docutils.languages
writing output... [ 15%] docutils.parsers
writing output... [ 20%] docutils.parsers.rst
writing output... [ 25%] docutils.parsers.rst.directives
writing output... [ 30%] docutils.parsers.rst.languages
writing output... [ 35%] docutils.readers
writing output... [ 40%] docutils.transforms
writing output... [ 45%] docutils.utils
writing output... [ 50%] docutils.utils.math
writing output... [ 55%] docutils.writers
writing output... [ 60%] docutils.writers.html4css1
writing output... [ 65%] docutils.writers.html5_polyglot
writing output... [ 70%] docutils.writers.latex2e
writing output... [ 75%] docutils.writers.odf_odt
writing output... [ 80%] docutils.writers.pep_html
writing output... [ 85%] docutils.writers.s5_html
writing output... [ 90%] docutils.writers.xetex
writing output... [ 95%] index
writing output... [100%] modules
/home/runner/sphinx_demo/docs/docutils.parsers.rst: WARNING: circular toctree references detected, ignoring: docutils.parsers <- docutils.parsers
/home/runner/sphinx_demo/docs/docutils.parsers.rst: WARNING: circular toctree references detected, ignoring: docutils.parsers <- docutils.parsers
/home/runner/sphinx_demo/docs/docutils.parsers.rst: WARNING: circular toctree references detected, ignoring: docutils.parsers <- docutils.parsers <- docutils
generating indices... genindex done
writing additional pages... search done
copying static files...
done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 128 warnings.
The HTML pages are in docs/_build/html.
!tree ./docs/_build/html -L 1
./docs/_build/html
├── _sources
├── _static
├── docutils.html
├── docutils.languages.html
├── docutils.parsers.html
├── docutils.parsers.rst.directives.html
├── docutils.parsers.rst.html
├── docutils.parsers.rst.languages.html
├── docutils.readers.html
├── docutils.transforms.html
├── docutils.utils.html
├── docutils.utils.math.html
├── docutils.writers.html
├── docutils.writers.html4css1.html
├── docutils.writers.html5_polyglot.html
├── docutils.writers.latex2e.html
├── docutils.writers.odf_odt.html
├── docutils.writers.pep_html.html
├── docutils.writers.s5_html.html
├── docutils.writers.xetex.html
├── genindex.html
├── index.html
├── modules.html
├── objects.inv
├── search.html
└── searchindex.js
2 directories, 24 files