usov_i-org/bec
1
0
Fork 0
mirror of https://github.com/ivan-usov-org/bec.git synced 2025-04-21 18:20:01 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: updated sphinx conf file to deal with md files; added copy button

Browse Source
This commit is contained in:
wakonig_k 2023-07-26 22:53:09 +02:00
parent 21d371a80b
commit 7f48ce6aa1
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/conf.py
View File

@ -36,12 +36,14 @@ extensions = [
# "sphinx.ext.coverage", # "sphinx.ext.coverage",
"sphinx.ext.napoleon", "sphinx.ext.napoleon",
"sphinx_toolbox.collapse", "sphinx_toolbox.collapse",
"sphinx_copybutton",
"myst_parser",
] ]
autosummary_generate = True # Turn on sphinx.ext.autosummary autosummary_generate = True # Turn on sphinx.ext.autosummary
# add_module_names = True # Remove namespaces from class/method signatures add_module_names = False # Remove namespaces from class/method signatures
# autodoc_inherit_docstrings = True # If no docstring, inherit from base class autodoc_inherit_docstrings = True # If no docstring, inherit from base class
# set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints
autoclass_content = "both" # Include both class docstring and __init__ autoclass_content = "both" # Include both class docstring and __init__
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

2
docs/source/requirements.txt
View File

@ -3,4 +3,6 @@ sphinx_copybutton
recommonmark recommonmark
sphinx-toolbox sphinx-toolbox
sphinx_rtd_theme sphinx_rtd_theme
sphinx-copybutton
myst-parser
bec_server bec_server