Skip to content

Commit

Permalink
Drop inheritance diagrams
Browse files Browse the repository at this point in the history
  • Loading branch information
philippjfr committed Sep 10, 2024
1 parent 49b19a0 commit 24d0e45
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
18 changes: 15 additions & 3 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,27 @@
"announcement": announcement_text,
}

extensions += [
'sphinx.ext.napoleon',

extensions = [
'myst_nb',
'sphinx_design',
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.linkcode',
'sphinx_copybutton',
'sphinxext.rediraffe',
'nbsite.gallery',
'nbsite.pyodide',
'nbsite.analytics',
'sphinx_copybutton',
]
napoleon_numpy_docstring = True

autodoc_mock_imports = ["panel.pane.vtk"]

myst_enable_extensions = ["colon_fence", "deflist"]

gallery_endpoint = 'panel-gallery-dev' if is_dev else 'panel-gallery'
Expand Down
7 changes: 0 additions & 7 deletions doc/generate_modules.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,10 @@ def format_directive(module, package=None):
directive += ' :%s:\n' % option
return directive

def format_inheritance_diagram(module, package=None):
"""Create the inheritance_diagram directive and add the options."""
directive = '.. inheritance-diagram:: %s\n' % makename(package, module)
return directive

def create_module_file(package, module, opts):
"""Build the text of the file and write the file."""

text = format_heading(1, '%s Module' % module)
text += format_inheritance_diagram(package, module)
text += format_heading(2, ':mod:`%s` Module' % module)
text += format_directive(module, package)
write_file(makename(package, module), text, opts)
Expand All @@ -109,7 +103,6 @@ def create_package_file(root, master_package, subroot, py_files, opts, subs):
else:
heading = ':mod:`%s` Module' % py_file
text += format_heading(2, heading)
text += format_inheritance_diagram(is_package and subroot or py_path, master_package)
text += '\n\n'
text += format_directive(is_package and subroot or py_path, master_package)
text += '\n-------\n\n'
Expand Down

0 comments on commit 24d0e45

Please sign in to comment.