From 7f48ce6aa1f2000993a4fb31e23a3efa3c122a57 Mon Sep 17 00:00:00 2001 From: Klaus Wakonig Date: Wed, 26 Jul 2023 22:53:09 +0200 Subject: [PATCH] docs: updated sphinx conf file to deal with md files; added copy button --- docs/source/conf.py | 8 +++++--- docs/source/requirements.txt | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d7da369b..046c19c9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,12 +36,14 @@ extensions = [ # "sphinx.ext.coverage", "sphinx.ext.napoleon", "sphinx_toolbox.collapse", + "sphinx_copybutton", + "myst_parser", ] autosummary_generate = True # Turn on sphinx.ext.autosummary -# add_module_names = True # Remove namespaces from class/method signatures -# autodoc_inherit_docstrings = True # If no docstring, inherit from base class -# set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints +add_module_names = False # Remove namespaces from class/method signatures +autodoc_inherit_docstrings = True # If no docstring, inherit from base class +set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints autoclass_content = "both" # Include both class docstring and __init__ # Add any paths that contain templates here, relative to this directory. diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt index 61aa2a5b..b67c4f3f 100644 --- a/docs/source/requirements.txt +++ b/docs/source/requirements.txt @@ -3,4 +3,6 @@ sphinx_copybutton recommonmark sphinx-toolbox sphinx_rtd_theme +sphinx-copybutton +myst-parser bec_server