Skip to content

Commit

Permalink
giving up for now, but there IS a way to have readthedocs generated t…
Browse files Browse the repository at this point in the history
…he .rst files itself

   see readthedocs/readthedocs.org#1139
  • Loading branch information
kevinanewman committed Jun 24, 2021
1 parent ac16f31 commit 024832c
Show file tree
Hide file tree
Showing 15 changed files with 682 additions and 3 deletions.
12 changes: 12 additions & 0 deletions doc/source/code_details.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Code Details
============

.. toctree::
:maxdepth: 4

exe_entry
omega_gui
omega_model
omega_preproc
setup
test_omega2
3 changes: 0 additions & 3 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,3 @@
master_doc = 'index'

add_module_names = False

from sphinx.apidoc import main
main(['--force', '--append-syspath', '--doc-project "Code Details"', '--doc-version 0.7.1', '--module-first', '--tocfile code_details'])
7 changes: 7 additions & 0 deletions doc/source/exe_entry.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
exe\_entry module
=================

.. automodule:: exe_entry
:members:
:undoc-members:
:show-inheritance:
42 changes: 42 additions & 0 deletions doc/source/omega_gui.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
omega\_gui package
==================

.. automodule:: omega_gui
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

omega\_gui.omega\_gui\_batch module
-----------------------------------

.. automodule:: omega_gui.omega_gui_batch
:members:
:undoc-members:
:show-inheritance:

omega\_gui.omega\_gui\_functions module
---------------------------------------

.. automodule:: omega_gui.omega_gui_functions
:members:
:undoc-members:
:show-inheritance:

omega\_gui.omega\_gui\_stylesheets module
-----------------------------------------

.. automodule:: omega_gui.omega_gui_stylesheets
:members:
:undoc-members:
:show-inheritance:

omega\_gui.sound\_gui module
----------------------------

.. automodule:: omega_gui.sound_gui
:members:
:undoc-members:
:show-inheritance:
90 changes: 90 additions & 0 deletions doc/source/omega_model.common.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
omega\_model.common package
===========================

.. automodule:: omega_model.common
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

omega\_model.common.file\_io module
-----------------------------------

.. automodule:: omega_model.common.file_io
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.input\_validation module
--------------------------------------------

.. automodule:: omega_model.common.input_validation
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_db module
------------------------------------

.. automodule:: omega_model.common.omega_db
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_dispy module
---------------------------------------

.. automodule:: omega_model.common.omega_dispy
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_functions module
-------------------------------------------

.. automodule:: omega_model.common.omega_functions
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_globals module
-----------------------------------------

.. automodule:: omega_model.common.omega_globals
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_log module
-------------------------------------

.. automodule:: omega_model.common.omega_log
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_plot module
--------------------------------------

.. automodule:: omega_model.common.omega_plot
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_trees module
---------------------------------------

.. automodule:: omega_model.common.omega_trees
:members:
:undoc-members:
:show-inheritance:

omega\_model.common.omega\_types module
---------------------------------------

.. automodule:: omega_model.common.omega_types
:members:
:undoc-members:
:show-inheritance:
82 changes: 82 additions & 0 deletions doc/source/omega_model.consumer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
omega\_model.consumer package
=============================

.. automodule:: omega_model.consumer
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

omega\_model.consumer.annual\_vmt\_fixed\_by\_age module
--------------------------------------------------------

.. automodule:: omega_model.consumer.annual_vmt_fixed_by_age
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.demanded\_shares\_gcam module
---------------------------------------------------

.. automodule:: omega_model.consumer.demanded_shares_gcam
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.market\_classes module
--------------------------------------------

.. automodule:: omega_model.consumer.market_classes
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.reregistration\_fixed\_by\_age module
-----------------------------------------------------------

.. automodule:: omega_model.consumer.reregistration_fixed_by_age
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.sales\_effect module
------------------------------------------

.. automodule:: omega_model.consumer.sales_effect
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.sales\_share\_gcam module
-----------------------------------------------

.. automodule:: omega_model.consumer.sales_share_gcam
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.sales\_share\_ma3t module
-----------------------------------------------

.. automodule:: omega_model.consumer.sales_share_ma3t
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.sales\_volume module
------------------------------------------

.. automodule:: omega_model.consumer.sales_volume
:members:
:undoc-members:
:show-inheritance:

omega\_model.consumer.stock module
----------------------------------

.. automodule:: omega_model.consumer.stock
:members:
:undoc-members:
:show-inheritance:
58 changes: 58 additions & 0 deletions doc/source/omega_model.context.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
omega\_model.context package
============================

.. automodule:: omega_model.context
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

omega\_model.context.cost\_clouds module
----------------------------------------

.. automodule:: omega_model.context.cost_clouds
:members:
:undoc-members:
:show-inheritance:

omega\_model.context.fuel\_prices module
----------------------------------------

.. automodule:: omega_model.context.fuel_prices
:members:
:undoc-members:
:show-inheritance:

omega\_model.context.new\_vehicle\_market module
------------------------------------------------

.. automodule:: omega_model.context.new_vehicle_market
:members:
:undoc-members:
:show-inheritance:

omega\_model.context.onroad\_fuels module
-----------------------------------------

.. automodule:: omega_model.context.onroad_fuels
:members:
:undoc-members:
:show-inheritance:

omega\_model.context.price\_modifications module
------------------------------------------------

.. automodule:: omega_model.context.price_modifications
:members:
:undoc-members:
:show-inheritance:

omega\_model.context.production\_constraints module
---------------------------------------------------

.. automodule:: omega_model.context.production_constraints
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 024832c

Please sign in to comment.