Skip to content

Commit 6ba51b0

Browse files
committed
Tidy doc/index.rst
- Reduce maxdepth 2 → 1 for most toctree directives. - Fix broken autosummary block. - Add some prefatory sentences.
1 parent 6233186 commit 6ba51b0

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/index.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,17 @@ and derived models including single-country models and `variants with greater se
88
All are built using the `MESSAGEix framework <https://docs.messageix.org>`_
99
and underlying `ix modeling platform (ixmp) <https://docs.messageix.org/ixmp/>`_.
1010

11-
Among other tasks, the tools allow modelers to:
11+
Among other tasks, these tools allow modelers to:
1212

1313
- retrieve input data from various upstream sources,
1414
- process/transform upstream data into model input parameters,
1515
- create, populate, modify, and parametrize scenarios,
1616
- conduct model runs,
17-
- set up model *variants* with additional details or features, and
17+
- build model variants with additional details or features, and
1818
- report quantities computed from model outputs.
1919

2020
.. toctree::
21-
:maxdepth: 2
21+
:maxdepth: 1
2222
:caption: User guide
2323

2424
install
@@ -61,15 +61,15 @@ API reference
6161

6262
Commonly used classes may be imported directly from :mod:`message_ix_models`.
6363

64-
.. automodule:: message_ix_models
64+
.. autosummary::
6565

66-
.. autosummary::
66+
message_ix_models.Config
67+
message_ix_models.Context
68+
message_ix_models.ScenarioInfo
69+
message_ix_models.Spec
70+
message_ix_models.Workflow
6771

68-
.Config
69-
.Context
70-
.ScenarioInfo
71-
.Spec
72-
.Workflow
72+
Other submodules are documented on their respective pages:
7373

7474
- :doc:`api/model`
7575
- :doc:`api/model-bare`
@@ -111,7 +111,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
111111
.. _index-variants:
112112

113113
.. toctree::
114-
:maxdepth: 2
114+
:maxdepth: 1
115115
:caption: Model variants
116116

117117
buildings/index
@@ -120,7 +120,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
120120
water/index
121121

122122
.. toctree::
123-
:maxdepth: 2
123+
:maxdepth: 1
124124
:caption: Research projects
125125

126126
project/advance
@@ -150,7 +150,7 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
150150
project/uptake
151151

152152
.. toctree::
153-
:maxdepth: 2
153+
:maxdepth: 1
154154
:caption: Package data
155155

156156
pkg-data/node

0 commit comments

Comments
 (0)