Skip to content

Commit d053548

Browse files
Copilotfumitoh
andauthored
DOC: Render Cell documentation inline instead of generating separate pages (#89)
* Initial plan * Update appliedlife RST files for inline cell documentation Co-authored-by: fumitoh <8450892+fumitoh@users.noreply.github.com> * Update basiclife and savings RST files for inline cell documentation Co-authored-by: fumitoh <8450892+fumitoh@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: fumitoh <8450892+fumitoh@users.noreply.github.com>
1 parent bb03315 commit d053548

File tree

14 files changed

+1290
-191
lines changed

14 files changed

+1290
-191
lines changed

makedocs/source/libraries/appliedlife/Assumptions.rst

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,26 @@ Formulas
99
-------------
1010

1111
.. autosummary::
12-
:toctree: ../generated/
13-
:template: mxbase.rst
1412

1513
~lapse_tables
1614
~asmp_file
1715
~mort_scalar_tables
1816
~stacked_lapse_tables
1917
~stacked_mort_scalar_tables
20-
~dyn_lapse_params
18+
~dyn_lapse_params
19+
20+
21+
Cells Descriptions
22+
------------------
23+
24+
.. autofunction:: lapse_tables
25+
26+
.. autofunction:: asmp_file
27+
28+
.. autofunction:: mort_scalar_tables
29+
30+
.. autofunction:: stacked_lapse_tables
31+
32+
.. autofunction:: stacked_mort_scalar_tables
33+
34+
.. autofunction:: dyn_lapse_params

makedocs/source/libraries/appliedlife/BaseData.rst

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,29 @@ Formulas
1010
-------------
1111

1212
.. autosummary::
13-
:toctree: ../generated/
14-
:template: mxbase.rst
1513

1614
~param_list
1715
~const_params
1816
~run_params
1917
~space_params
2018
~product_params
2119
~surr_charge_tables
22-
~stacked_surr_charge_tables
20+
~stacked_surr_charge_tables
21+
22+
23+
Cells Descriptions
24+
------------------
25+
26+
.. autofunction:: param_list
27+
28+
.. autofunction:: const_params
29+
30+
.. autofunction:: run_params
31+
32+
.. autofunction:: space_params
33+
34+
.. autofunction:: product_params
35+
36+
.. autofunction:: surr_charge_tables
37+
38+
.. autofunction:: stacked_surr_charge_tables

makedocs/source/libraries/appliedlife/ModelPoints.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@ Formulas
88
-------------
99

1010
.. autosummary::
11-
:toctree: ../generated/
12-
:template: mxbase.rst
1311

1412
~model_point_table
1513
~model_point_table_ext
1614

15+
16+
Cells Descriptions
17+
------------------
18+
19+
.. autofunction:: model_point_table
20+
21+
.. autofunction:: model_point_table_ext

makedocs/source/libraries/appliedlife/Mortality.rst

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,32 @@ Formulas
99
-------------
1010

1111
.. autosummary::
12-
:toctree: ../generated/
13-
:template: mxbase.rst
14-
15-
table_defs
16-
select_table
17-
ultimate_tables
18-
select_duration_len
19-
merged_table
20-
unified_table
21-
mort_file
22-
table_last_age
12+
13+
~table_defs
14+
~select_table
15+
~ultimate_tables
16+
~select_duration_len
17+
~merged_table
18+
~unified_table
19+
~mort_file
20+
~table_last_age
21+
22+
23+
Cells Descriptions
24+
------------------
25+
26+
.. autofunction:: table_defs
27+
28+
.. autofunction:: select_table
29+
30+
.. autofunction:: ultimate_tables
31+
32+
.. autofunction:: select_duration_len
33+
34+
.. autofunction:: merged_table
35+
36+
.. autofunction:: unified_table
37+
38+
.. autofunction:: mort_file
39+
40+
.. autofunction:: table_last_age

0 commit comments

Comments
 (0)