|
36 | 36 | # Add any Sphinx extension module names here, as strings. They can be |
37 | 37 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
38 | 38 | # 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 | +] |
40 | 51 |
|
41 | 52 | # autosummary and autodoc configurations |
42 | | -# autosummary_generate = True |
43 | | -""" |
| 53 | +autosummary_generate = True |
| 54 | + |
44 | 55 | autodoc_member_order = "bysource" |
45 | 56 | autodoc_default_options = { |
46 | 57 | "members": True, |
47 | 58 | "undoc-members": True, |
48 | 59 | "private-members": True, |
49 | 60 | } |
50 | 61 | autodoc_typehints = "none" |
51 | | -""" |
52 | 62 |
|
53 | 63 | # Napoleon configurations |
54 | 64 | napoleon_google_docstring = False |
|
57 | 67 | napoleon_use_rtype = False |
58 | 68 | napoleon_preprocess_types = True |
59 | 69 |
|
| 70 | +# sphinx-copybutton configurations |
| 71 | +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " |
| 72 | +copybutton_prompt_is_regexp = True |
| 73 | + |
60 | 74 | # 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'] |
63 | 77 |
|
64 | 78 | # The suffix(es) of source filenames. |
65 | 79 | # You can specify multiple suffix as a list of string: |
|
70 | 84 | # The master toctree document. |
71 | 85 | master_doc = "index" |
72 | 86 |
|
| 87 | +# General information about the project. |
| 88 | +project = "PCMDI Metrics Package (PMP)" |
| 89 | +copyright = "2024, PMP Developers" |
| 90 | +author = "PMP Developers" |
| 91 | + |
73 | 92 | # The language for content autogenerated by Sphinx. Refer to documentation |
74 | 93 | # for a list of supported languages. |
75 | 94 | # |
|
80 | 99 | # List of patterns, relative to source directory, that match files and |
81 | 100 | # directories to ignore when looking for source files. |
82 | 101 | # 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 | +] |
84 | 108 |
|
85 | 109 | # The name of the Pygments (syntax highlighting) style to use. |
86 | 110 | pygments_style = 'sphinx' |
|
0 commit comments