diff options
| author | Patrick Lehmann <Patrick.Lehmann@plc2.de> | 2022-06-24 23:19:41 +0200 |
|---|---|---|
| committer | Patrick Lehmann <Patrick.Lehmann@plc2.de> | 2022-12-24 10:03:53 +0100 |
| commit | ef330ba87ea2fc808e1043f8cab4662565257e67 (patch) | |
| tree | 778e717ab35b79e954f6f630c25f5a436dba9551 | |
| parent | e284c9245a01e1709f59dec260cef53f4fb76530 (diff) | |
| download | ghdl-ef330ba87ea2fc808e1043f8cab4662565257e67.tar.gz ghdl-ef330ba87ea2fc808e1043f8cab4662565257e67.tar.bz2 ghdl-ef330ba87ea2fc808e1043f8cab4662565257e67.zip | |
Updated Sphinx configuration.
(cherry picked from commit fe702ec6fc634c72d98e174d4fba5b9aa014aa45)
| -rw-r--r-- | doc/conf.py | 28 |
1 files changed, 20 insertions, 8 deletions
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" # ============================================================================== @@ -230,6 +225,17 @@ 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 # ============================================================================== # If true, `todo` and `todoList` produce output, else they produce nothing. @@ -238,6 +244,12 @@ todo_link_only = True # ============================================================================== +# Sphinx.Ext.Coverage +# ============================================================================== +coverage_show_missing_items = True + + +# ============================================================================== # Sphinx.Ext.ExtLinks # ============================================================================== extlinks = { |