Skip to content

Commit 024832c

Browse files
committed
giving up for now, but there IS a way to have readthedocs generated the .rst files itself
see readthedocs/readthedocs.org#1139
1 parent ac16f31 commit 024832c

15 files changed

+682
-3
lines changed

doc/source/code_details.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Code Details
2+
============
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
exe_entry
8+
omega_gui
9+
omega_model
10+
omega_preproc
11+
setup
12+
test_omega2

doc/source/conf.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,3 @@
9999
master_doc = 'index'
100100

101101
add_module_names = False
102-
103-
from sphinx.apidoc import main
104-
main(['--force', '--append-syspath', '--doc-project "Code Details"', '--doc-version 0.7.1', '--module-first', '--tocfile code_details'])

doc/source/exe_entry.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
exe\_entry module
2+
=================
3+
4+
.. automodule:: exe_entry
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

doc/source/omega_gui.rst

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
omega\_gui package
2+
==================
3+
4+
.. automodule:: omega_gui
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
omega\_gui.omega\_gui\_batch module
13+
-----------------------------------
14+
15+
.. automodule:: omega_gui.omega_gui_batch
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
omega\_gui.omega\_gui\_functions module
21+
---------------------------------------
22+
23+
.. automodule:: omega_gui.omega_gui_functions
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
omega\_gui.omega\_gui\_stylesheets module
29+
-----------------------------------------
30+
31+
.. automodule:: omega_gui.omega_gui_stylesheets
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
omega\_gui.sound\_gui module
37+
----------------------------
38+
39+
.. automodule:: omega_gui.sound_gui
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:

doc/source/omega_model.common.rst

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
omega\_model.common package
2+
===========================
3+
4+
.. automodule:: omega_model.common
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
omega\_model.common.file\_io module
13+
-----------------------------------
14+
15+
.. automodule:: omega_model.common.file_io
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
omega\_model.common.input\_validation module
21+
--------------------------------------------
22+
23+
.. automodule:: omega_model.common.input_validation
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
omega\_model.common.omega\_db module
29+
------------------------------------
30+
31+
.. automodule:: omega_model.common.omega_db
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
omega\_model.common.omega\_dispy module
37+
---------------------------------------
38+
39+
.. automodule:: omega_model.common.omega_dispy
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
omega\_model.common.omega\_functions module
45+
-------------------------------------------
46+
47+
.. automodule:: omega_model.common.omega_functions
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
omega\_model.common.omega\_globals module
53+
-----------------------------------------
54+
55+
.. automodule:: omega_model.common.omega_globals
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
omega\_model.common.omega\_log module
61+
-------------------------------------
62+
63+
.. automodule:: omega_model.common.omega_log
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
omega\_model.common.omega\_plot module
69+
--------------------------------------
70+
71+
.. automodule:: omega_model.common.omega_plot
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
omega\_model.common.omega\_trees module
77+
---------------------------------------
78+
79+
.. automodule:: omega_model.common.omega_trees
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
omega\_model.common.omega\_types module
85+
---------------------------------------
86+
87+
.. automodule:: omega_model.common.omega_types
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:

doc/source/omega_model.consumer.rst

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
omega\_model.consumer package
2+
=============================
3+
4+
.. automodule:: omega_model.consumer
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
omega\_model.consumer.annual\_vmt\_fixed\_by\_age module
13+
--------------------------------------------------------
14+
15+
.. automodule:: omega_model.consumer.annual_vmt_fixed_by_age
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
omega\_model.consumer.demanded\_shares\_gcam module
21+
---------------------------------------------------
22+
23+
.. automodule:: omega_model.consumer.demanded_shares_gcam
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
omega\_model.consumer.market\_classes module
29+
--------------------------------------------
30+
31+
.. automodule:: omega_model.consumer.market_classes
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
omega\_model.consumer.reregistration\_fixed\_by\_age module
37+
-----------------------------------------------------------
38+
39+
.. automodule:: omega_model.consumer.reregistration_fixed_by_age
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
omega\_model.consumer.sales\_effect module
45+
------------------------------------------
46+
47+
.. automodule:: omega_model.consumer.sales_effect
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
omega\_model.consumer.sales\_share\_gcam module
53+
-----------------------------------------------
54+
55+
.. automodule:: omega_model.consumer.sales_share_gcam
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
omega\_model.consumer.sales\_share\_ma3t module
61+
-----------------------------------------------
62+
63+
.. automodule:: omega_model.consumer.sales_share_ma3t
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
omega\_model.consumer.sales\_volume module
69+
------------------------------------------
70+
71+
.. automodule:: omega_model.consumer.sales_volume
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
omega\_model.consumer.stock module
77+
----------------------------------
78+
79+
.. automodule:: omega_model.consumer.stock
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:

doc/source/omega_model.context.rst

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
omega\_model.context package
2+
============================
3+
4+
.. automodule:: omega_model.context
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
omega\_model.context.cost\_clouds module
13+
----------------------------------------
14+
15+
.. automodule:: omega_model.context.cost_clouds
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
omega\_model.context.fuel\_prices module
21+
----------------------------------------
22+
23+
.. automodule:: omega_model.context.fuel_prices
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
omega\_model.context.new\_vehicle\_market module
29+
------------------------------------------------
30+
31+
.. automodule:: omega_model.context.new_vehicle_market
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
omega\_model.context.onroad\_fuels module
37+
-----------------------------------------
38+
39+
.. automodule:: omega_model.context.onroad_fuels
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
omega\_model.context.price\_modifications module
45+
------------------------------------------------
46+
47+
.. automodule:: omega_model.context.price_modifications
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
omega\_model.context.production\_constraints module
53+
---------------------------------------------------
54+
55+
.. automodule:: omega_model.context.production_constraints
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:

0 commit comments

Comments
 (0)