Skip to content

Commit

Permalink
rename from master_doc to root_doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeitsperre committed Feb 26, 2024
1 parent bb71460 commit 2cf856f
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@
for module in ("atmos", "generic", "land", "seaIce", "icclim", "anuclim"):
for key, ind in getattr(xclim.indicators, module).__dict__.items():
if hasattr(ind, "_registry_id") and ind._registry_id in registry: # noqa
indicators[ind._registry_id] = {
indicators[ind._registry_id] = { # noqa
"realm": ind.realm,
"title": ind.title,
"name": key,
"module": module,
"abstract": ind.abstract,
"vars": {
param_name: f"{param.description}"
for param_name, param in ind._all_parameters.items()
for param_name, param in ind._all_parameters.items() # noqa
if param.kind < 2 and not param.injected
},
"keywords": ind.keywords.split(","),
Expand Down Expand Up @@ -234,8 +234,8 @@ class XCStyle(AlphaStyle):
# If a list of string, all suffixes will be understood as restructured text variants.
source_suffix = [".rst"]

# The master toctree document.
master_doc = "index"
# The root toctree document.
root_doc = "index"

# General information about the project.
project = "xclim"
Expand Down Expand Up @@ -338,7 +338,7 @@ class XCStyle(AlphaStyle):
# [howto, manual, or own class]).
latex_documents = [
(
master_doc,
root_doc,
"xclim.tex",
"xclim Documentation",
"xclim Project Development Team",
Expand All @@ -350,7 +350,15 @@ class XCStyle(AlphaStyle):

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, "xclim", "xclim Documentation", [author], 1)]
man_pages = [
(
root_doc,
"xclim",
"xclim Documentation",
[author],
1,
)
]

# -- Options for Texinfo output ----------------------------------------

Expand All @@ -359,7 +367,7 @@ class XCStyle(AlphaStyle):
# dir menu entry, description, category)
texinfo_documents = [
(
master_doc,
root_doc,
"xclim",
"xclim Documentation",
author,
Expand Down

0 comments on commit 2cf856f

Please sign in to comment.