Skip to content

Commit 41a66fa

Browse files
authored
Update conf.py
1 parent 977af90 commit 41a66fa

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

docs/conf.py

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,29 @@
3636
# Add any Sphinx extension module names here, as strings. They can be
3737
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3838
# ones.
39-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_rtd_theme', 'sphinx.ext.napoleon']
39+
#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx_rtd_theme', 'sphinx.ext.napoleon']
40+
extensions = [
41+
"sphinx.ext.autodoc",
42+
"sphinx.ext.autosummary",
43+
"sphinx.ext.napoleon",
44+
"sphinx.ext.viewcode",
45+
"sphinx_autosummary_accessors",
46+
"sphinx_copybutton",
47+
"sphinx_rtd_theme",
48+
"nbsphinx",
49+
"sphinx_design",
50+
]
4051

4152
# autosummary and autodoc configurations
42-
# autosummary_generate = True
43-
"""
53+
autosummary_generate = True
54+
4455
autodoc_member_order = "bysource"
4556
autodoc_default_options = {
4657
"members": True,
4758
"undoc-members": True,
4859
"private-members": True,
4960
}
5061
autodoc_typehints = "none"
51-
"""
5262

5363
# Napoleon configurations
5464
napoleon_google_docstring = False
@@ -57,9 +67,13 @@
5767
napoleon_use_rtype = False
5868
napoleon_preprocess_types = True
5969

70+
# sphinx-copybutton configurations
71+
copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
72+
copybutton_prompt_is_regexp = True
73+
6074
# Add any paths that contain templates here, relative to this directory.
61-
# templates_path = ['_templates', sphinx_autosummary_accessors.templates_path]
62-
templates_path = ['_templates']
75+
templates_path = ["_templates", sphinx_autosummary_accessors.templates_path]
76+
# templates_path = ['_templates']
6377

6478
# The suffix(es) of source filenames.
6579
# You can specify multiple suffix as a list of string:
@@ -70,6 +84,11 @@
7084
# The master toctree document.
7185
master_doc = "index"
7286

87+
# General information about the project.
88+
project = "PCMDI Metrics Package (PMP)"
89+
copyright = "2024, PMP Developers"
90+
author = "PMP Developers"
91+
7392
# The language for content autogenerated by Sphinx. Refer to documentation
7493
# for a list of supported languages.
7594
#
@@ -80,7 +99,12 @@
8099
# List of patterns, relative to source directory, that match files and
81100
# directories to ignore when looking for source files.
82101
# This pattern also affects html_static_path and html_extra_path.
83-
exclude_patterns = []
102+
exclude_patterns = [
103+
"_build",
104+
"Thumbs.db",
105+
".DS_Store",
106+
"demos/1-25-23-cwss-seminar/xsearch-xcdat-example.ipynb",
107+
]
84108

85109
# The name of the Pygments (syntax highlighting) style to use.
86110
pygments_style = 'sphinx'

0 commit comments

Comments
 (0)