Skip to content

Commit 8cceb9b

Browse files
Fixes to Sphinx config. to maintain API ref. custom structure
1 parent 70b9b1c commit 8cceb9b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

docs/source/conf.py

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222

2323
import cf
2424

25+
2526
print("\ncf environment:")
2627
print("-----------------")
2728
cf.environment()
@@ -78,7 +79,7 @@ def _get_date():
7879
# -- General configuration ----------------------------------------------------
7980

8081
# If your documentation needs a minimal Sphinx version, state it here.
81-
needs_sphinx = "2.3.1"
82+
needs_sphinx = "7.0.0"
8283

8384
# rst_prolog = """
8485
# .. |CF| replace:: """+_get_cf_version()+"""
@@ -113,10 +114,11 @@ def _get_date():
113114
tokenizer_lang = "en_GB"
114115
spelling_word_list_filename = "spelling_false_positives.txt"
115116

116-
# Boolean indicating whether to scan all found documents for
117-
# autosummary directives, and to generate stub pages for each
118-
# (http://sphinx-doc.org/latest/ext/autosummary.html)
119-
autosummary_generate = True
117+
# SLB, DH NOTE: we don't want to generate these stubs as they use templates
118+
# from _templates/autosummary which override our custom sub-section lists
119+
# in our class/*.rst reference files, which we want to use directly! So this
120+
# flag setting is crucial.
121+
autosummary_generate = False
120122

121123
# Both the class’ and the __init__ method’s docstring are concatenated
122124
# and inserted.
@@ -157,7 +159,7 @@ def _get_date():
157159
"matplotlib": ("https://matplotlib.org/stable/", None),
158160
# REVIEW: h5: new intersphinx mapping
159161
"h5netcdf": ("https://h5netcdf.org", None),
160-
"zarr": ("https://zarr.readthedocs.io", None),
162+
"zarr": ("https://zarr.readthedocs.io/en/stable/", None),
161163
}
162164

163165
# This extension is meant to help with the common pattern of having

0 commit comments

Comments
 (0)