mam/mamweb
13
1
Fork 0
Code Issues Pull requests 12 Projects Wiki Activity Actions

Další konfigurace sphinx

Browse source
This commit is contained in:
Jonas Havelka 2022-02-15 17:45:52 +01:00
parent 5d61190695
commit cbf17f7709
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/conf.py
View file

@ -33,6 +33,8 @@ author = 'Orgové'
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel'
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -67,5 +69,17 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# Provázání s jinými dokumentacemi
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
'django': ('http://docs.djangoproject.com/en/3.2/',
'http://docs.djangoproject.com/en/3.2/_objects/'),}
# Generování tříd/funkcí/atributů v pořádí jak jsou naprogramované
autodoc_member_order = "bysource"
# Nezobrazování zděděné (ze super tříd) dokumentace TODO nefunguje?
autodoc_inherit_docstrings = False
# Spouštění sphinx-apidoc
from sphinx.ext.apidoc import main from sphinx.ext.apidoc import main
main(['--module-first', '-o', "modules", "..", "../*/migrations", "--templatedir", "_templates", '-f']) main(['--module-first', '-o', "modules", "..", "../*/migrations", "--templatedir", "_templates", '-f'])