Skip to content

Commit e99f72f

Browse files
committed
Add (temporary?) docs page for #275 work items
1 parent 43ce610 commit e99f72f

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

doc/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,12 @@ def setup(app: "sphinx.application.Sphinx") -> None:
171171
"pull": ("https://github.com/iiasa/message-ix-models/pull/%s", "PR #%s"),
172172
"gh-user": ("https://github.com/%s", "@%s"),
173173
"source": ("https://github.com/iiasa/message-ix-models/blob/main/%s", "%s"),
174+
# Temporary, for #275. DO NOT use these except in doc/dev/275.rst
175+
"md-to-migrate": ("https://github.com/iiasa/message_data/blob/ssp_dev/%s", None),
176+
"msc-to-migrate": (
177+
"https://github.com/iiasa/message_single_country/blob/SSP_Dev_2023/%s",
178+
None,
179+
),
174180
}
175181

176182
# -- Options for sphinx.ext.intersphinx ------------------------------------------------

doc/dev/275.rst

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Summary for :issue:`275`
2+
************************
3+
4+
- Keep the list in alphabetical order.
5+
- In each row, enter:
6+
7+
**Name**
8+
A short name for the module, function, or collection of such.
9+
**m_data**
10+
Link to one code or data file on the ``ssp_dev`` branch of ``message_data``, if any.
11+
If there are multiple files, choose one.
12+
**m_s_country**
13+
Link to one code or data file on the ``SSP_Dev_2023`` branch of ``message_single_country``, if any.
14+
If there are multiple files, choose one.
15+
If the file is present in both message_data and message_single_country, these links should correspond in order to support diff of the two versions.
16+
**m-ix-models**
17+
Link to one code or data file on the ``main`` branch of ``message-ix-models``, for instance if the item has already been migrated as a dependency of other code.
18+
If this migration has not happened yet, put "None".
19+
**Pick**
20+
Either "m_data", "m_single_country", or "m-ix-models", indicating which version of the code/data files will be preferred.
21+
**PR/issue**
22+
Link to, *at minimum*, a message-ix-models pull request that adds or updates the item, or an issue gathering more info than appears in the table.
23+
Use the usual GitHub features to:
24+
25+
- Track the assignees, review assignments, status, checklist items, etc. associated with the PR.
26+
- Cross-reference additional PRs that remove the corresponding files or code from message_data and/or message_single_country.
27+
28+
.. list-table::
29+
:header-rows: 1
30+
31+
* - Name
32+
- m_data
33+
- m_s_country
34+
- m_ix_models
35+
- Pick
36+
- PR/issue
37+
38+
* - ``res_marg``
39+
- :md-to-migrate:`link <message_data/scenario_generation/reserve_margin/res_marg.py>`
40+
- :msc-to-migrate:`link <SSP_Dev_2023/models/modules/res_marg.py>`
41+
- None
42+
- TODO
43+
- TODO
44+
45+
.. Here are some further notes about this item.
46+
Such notes **may** be kept here, but **must** be moved to an issue/PR as soon as one is opened, and deleted here.

0 commit comments

Comments
 (0)