From ef330ba87ea2fc808e1043f8cab4662565257e67 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 24 Jun 2022 23:19:41 +0200 Subject: Updated Sphinx configuration. (cherry picked from commit fe702ec6fc634c72d98e174d4fba5b9aa014aa45) --- doc/conf.py | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) (limited to 'doc/conf.py') diff --git a/doc/conf.py b/doc/conf.py index 7bbb1e054..f1ce09fd9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -63,7 +63,7 @@ exclude_patterns = [ ] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'stata-dark' +pygments_style = 'manni' # ============================================================================== @@ -202,7 +202,7 @@ extensions = [ # Sphinx.Ext.InterSphinx # ============================================================================== intersphinx_mapping = { - 'python': ('https://docs.python.org/3.6/', None), + 'python': ('https://docs.python.org/3', None), 'cosim': ('https://ghdl.github.io/ghdl-cosim', None), 'poc': ('https://poc-library.readthedocs.io/en/release', None), 'vhdlmodel': ('https://vhdl.github.io/pyVHDLModel', None), @@ -215,12 +215,7 @@ intersphinx_mapping = { # ============================================================================== # see: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#configuration autodoc_member_order = "bysource" # alphabetical, groupwise, bysource -# autodoc_default_options = { -# "members": True, -# 'undoc-members': True, -# #'private-members': True, -# 'inherited-members': True, -# } +autodoc_typehints = "both" # ============================================================================== @@ -229,6 +224,17 @@ autodoc_member_order = "bysource" # alphabetical, groupwise, bysource graphviz_output_format = "svg" +# ============================================================================== +# Sphinx.Ext.Inheritance_Diagram +# ============================================================================== +inheritance_node_attrs = { +# "shape": "ellipse", +# "fontsize": 14, +# "height": 0.75, + "color": "dodgerblue1", + "style": "filled" +} + # ============================================================================== # Sphinx.Ext.ToDo # ============================================================================== @@ -237,6 +243,12 @@ todo_include_todos = True todo_link_only = True +# ============================================================================== +# Sphinx.Ext.Coverage +# ============================================================================== +coverage_show_missing_items = True + + # ============================================================================== # Sphinx.Ext.ExtLinks # ============================================================================== -- cgit v1.2.3 From 3e0ccf6230010bdcf0f49c777a06dc1aa168abf4 Mon Sep 17 00:00:00 2001 From: Patrick Lehmann Date: Fri, 24 Jun 2022 23:58:04 +0200 Subject: Removed/disabled customized Sphinx/BTD extensions. (cherry picked from commit d5ff8ffe2e56f614b1c942913796a2733a68aab7) --- doc/conf.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'doc/conf.py') diff --git a/doc/conf.py b/doc/conf.py index f1ce09fd9..3ed641b56 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -174,26 +174,24 @@ extensions = [ # Standard Sphinx extensions 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', + 'sphinx.ext.inheritance_diagram', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', -# 'sphinx.ext.graphviz', + 'sphinx.ext.graphviz', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', # BuildTheDocs extensions 'btd.sphinx.autoprogram', - 'btd.sphinx.graphviz', - 'btd.sphinx.inheritance_diagram', +# 'btd.sphinx.graphviz', +# 'btd.sphinx.inheritance_diagram', # Other extensions # 'recommonmark', 'exec', -# 'DocumentMember', 'sphinx_fontawesome', 'sphinx_autodoc_typehints', - - # local extensions (patched) 'autoapi.sphinx', ] -- cgit v1.2.3