From 024832cfbf6488f0c30152aca83af1d12134f37c Mon Sep 17 00:00:00 2001 From: kevinnewman Date: Thu, 24 Jun 2021 13:06:05 -0400 Subject: [PATCH] giving up for now, but there IS a way to have readthedocs generated the .rst files itself see https://github.com/readthedocs/readthedocs.org/issues/1139 --- doc/source/code_details.rst | 12 ++ doc/source/conf.py | 3 - doc/source/exe_entry.rst | 7 + doc/source/omega_gui.rst | 42 ++++++ doc/source/omega_model.common.rst | 90 +++++++++++++ doc/source/omega_model.consumer.rst | 82 ++++++++++++ doc/source/omega_model.context.rst | 58 +++++++++ doc/source/omega_model.effects.rst | 122 ++++++++++++++++++ doc/source/omega_model.policy.rst | 98 ++++++++++++++ doc/source/omega_model.producer.rst | 50 +++++++ doc/source/omega_model.rst | 55 ++++++++ .../omega_preproc.alpha_package_costs.rst | 26 ++++ doc/source/omega_preproc.rst | 26 ++++ doc/source/setup.rst | 7 + doc/source/test_omega2.rst | 7 + 15 files changed, 682 insertions(+), 3 deletions(-) create mode 100644 doc/source/code_details.rst create mode 100644 doc/source/exe_entry.rst create mode 100644 doc/source/omega_gui.rst create mode 100644 doc/source/omega_model.common.rst create mode 100644 doc/source/omega_model.consumer.rst create mode 100644 doc/source/omega_model.context.rst create mode 100644 doc/source/omega_model.effects.rst create mode 100644 doc/source/omega_model.policy.rst create mode 100644 doc/source/omega_model.producer.rst create mode 100644 doc/source/omega_model.rst create mode 100644 doc/source/omega_preproc.alpha_package_costs.rst create mode 100644 doc/source/omega_preproc.rst create mode 100644 doc/source/setup.rst create mode 100644 doc/source/test_omega2.rst diff --git a/doc/source/code_details.rst b/doc/source/code_details.rst new file mode 100644 index 00000000..bdae5fc3 --- /dev/null +++ b/doc/source/code_details.rst @@ -0,0 +1,12 @@ +Code Details +============ + +.. toctree:: + :maxdepth: 4 + + exe_entry + omega_gui + omega_model + omega_preproc + setup + test_omega2 diff --git a/doc/source/conf.py b/doc/source/conf.py index d5a4d46b..a37b42cc 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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']) diff --git a/doc/source/exe_entry.rst b/doc/source/exe_entry.rst new file mode 100644 index 00000000..e8ec008c --- /dev/null +++ b/doc/source/exe_entry.rst @@ -0,0 +1,7 @@ +exe\_entry module +================= + +.. automodule:: exe_entry + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_gui.rst b/doc/source/omega_gui.rst new file mode 100644 index 00000000..d9002983 --- /dev/null +++ b/doc/source/omega_gui.rst @@ -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: diff --git a/doc/source/omega_model.common.rst b/doc/source/omega_model.common.rst new file mode 100644 index 00000000..b878684d --- /dev/null +++ b/doc/source/omega_model.common.rst @@ -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: diff --git a/doc/source/omega_model.consumer.rst b/doc/source/omega_model.consumer.rst new file mode 100644 index 00000000..867c943a --- /dev/null +++ b/doc/source/omega_model.consumer.rst @@ -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: diff --git a/doc/source/omega_model.context.rst b/doc/source/omega_model.context.rst new file mode 100644 index 00000000..f70277fd --- /dev/null +++ b/doc/source/omega_model.context.rst @@ -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: diff --git a/doc/source/omega_model.effects.rst b/doc/source/omega_model.effects.rst new file mode 100644 index 00000000..238e341d --- /dev/null +++ b/doc/source/omega_model.effects.rst @@ -0,0 +1,122 @@ +omega\_model.effects package +============================ + +.. automodule:: omega_model.effects + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +omega\_model.effects.cost\_effects\_criteria module +--------------------------------------------------- + +.. automodule:: omega_model.effects.cost_effects_criteria + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_effects\_non\_emissions module +--------------------------------------------------------- + +.. automodule:: omega_model.effects.cost_effects_non_emissions + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_effects\_scc module +---------------------------------------------- + +.. automodule:: omega_model.effects.cost_effects_scc + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_factors\_congestion\_noise module +------------------------------------------------------------ + +.. automodule:: omega_model.effects.cost_factors_congestion_noise + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_factors\_criteria module +--------------------------------------------------- + +.. automodule:: omega_model.effects.cost_factors_criteria + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_factors\_energysecurity module +--------------------------------------------------------- + +.. automodule:: omega_model.effects.cost_factors_energysecurity + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.cost\_factors\_scc module +---------------------------------------------- + +.. automodule:: omega_model.effects.cost_factors_scc + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.emission\_factors\_powersector module +---------------------------------------------------------- + +.. automodule:: omega_model.effects.emission_factors_powersector + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.emission\_factors\_refinery module +------------------------------------------------------- + +.. automodule:: omega_model.effects.emission_factors_refinery + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.emission\_factors\_vehicles module +------------------------------------------------------- + +.. automodule:: omega_model.effects.emission_factors_vehicles + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.general\_functions module +---------------------------------------------- + +.. automodule:: omega_model.effects.general_functions + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.inventory module +------------------------------------- + +.. automodule:: omega_model.effects.inventory + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.o2\_effects module +--------------------------------------- + +.. automodule:: omega_model.effects.o2_effects + :members: + :undoc-members: + :show-inheritance: + +omega\_model.effects.social\_costs module +----------------------------------------- + +.. automodule:: omega_model.effects.social_costs + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_model.policy.rst b/doc/source/omega_model.policy.rst new file mode 100644 index 00000000..e9ac7b2b --- /dev/null +++ b/doc/source/omega_model.policy.rst @@ -0,0 +1,98 @@ +omega\_model.policy package +=========================== + +.. automodule:: omega_model.policy + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +omega\_model.policy.credit\_banking module +------------------------------------------ + +.. automodule:: omega_model.policy.credit_banking + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.drive\_cycle\_weights module +------------------------------------------------ + +.. automodule:: omega_model.policy.drive_cycle_weights + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.drive\_cycles module +---------------------------------------- + +.. automodule:: omega_model.policy.drive_cycles + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.incentives module +------------------------------------- + +.. automodule:: omega_model.policy.incentives + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.offcycle\_credits module +-------------------------------------------- + +.. automodule:: omega_model.policy.offcycle_credits + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.policy\_fuel\_upstream module +------------------------------------------------- + +.. automodule:: omega_model.policy.policy_fuel_upstream + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.policy\_fuels module +---------------------------------------- + +.. automodule:: omega_model.policy.policy_fuels + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.required\_zev\_share module +----------------------------------------------- + +.. automodule:: omega_model.policy.required_zev_share + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.targets\_flat module +---------------------------------------- + +.. automodule:: omega_model.policy.targets_flat + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.targets\_footprint module +--------------------------------------------- + +.. automodule:: omega_model.policy.targets_footprint + :members: + :undoc-members: + :show-inheritance: + +omega\_model.policy.upstream\_methods module +-------------------------------------------- + +.. automodule:: omega_model.policy.upstream_methods + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_model.producer.rst b/doc/source/omega_model.producer.rst new file mode 100644 index 00000000..b208a373 --- /dev/null +++ b/doc/source/omega_model.producer.rst @@ -0,0 +1,50 @@ +omega\_model.producer package +============================= + +.. automodule:: omega_model.producer + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +omega\_model.producer.compliance\_strategy module +------------------------------------------------- + +.. automodule:: omega_model.producer.compliance_strategy + :members: + :undoc-members: + :show-inheritance: + +omega\_model.producer.manufacturer\_annual\_data module +------------------------------------------------------- + +.. automodule:: omega_model.producer.manufacturer_annual_data + :members: + :undoc-members: + :show-inheritance: + +omega\_model.producer.manufacturers module +------------------------------------------ + +.. automodule:: omega_model.producer.manufacturers + :members: + :undoc-members: + :show-inheritance: + +omega\_model.producer.vehicle\_annual\_data module +-------------------------------------------------- + +.. automodule:: omega_model.producer.vehicle_annual_data + :members: + :undoc-members: + :show-inheritance: + +omega\_model.producer.vehicles module +------------------------------------- + +.. automodule:: omega_model.producer.vehicles + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_model.rst b/doc/source/omega_model.rst new file mode 100644 index 00000000..c7dd32f0 --- /dev/null +++ b/doc/source/omega_model.rst @@ -0,0 +1,55 @@ +omega\_model package +==================== + +.. automodule:: omega_model + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + omega_model.common + omega_model.consumer + omega_model.context + omega_model.effects + omega_model.policy + omega_model.producer + +Submodules +---------- + +omega\_model.omega module +------------------------- + +.. automodule:: omega_model.omega + :members: + :undoc-members: + :show-inheritance: + +omega\_model.omega\_batch module +-------------------------------- + +.. automodule:: omega_model.omega_batch + :members: + :undoc-members: + :show-inheritance: + +omega\_model.postproc\_batch module +----------------------------------- + +.. automodule:: omega_model.postproc_batch + :members: + :undoc-members: + :show-inheritance: + +omega\_model.postproc\_session module +------------------------------------- + +.. automodule:: omega_model.postproc_session + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_preproc.alpha_package_costs.rst b/doc/source/omega_preproc.alpha_package_costs.rst new file mode 100644 index 00000000..789469e4 --- /dev/null +++ b/doc/source/omega_preproc.alpha_package_costs.rst @@ -0,0 +1,26 @@ +omega\_preproc.alpha\_package\_costs package +============================================ + +.. automodule:: omega_preproc.alpha_package_costs + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +omega\_preproc.alpha\_package\_costs.alpha\_package\_costs module +----------------------------------------------------------------- + +.. automodule:: omega_preproc.alpha_package_costs.alpha_package_costs + :members: + :undoc-members: + :show-inheritance: + +omega\_preproc.alpha\_package\_costs.make\_hev\_from\_alpha\_ice module +----------------------------------------------------------------------- + +.. automodule:: omega_preproc.alpha_package_costs.make_hev_from_alpha_ice + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/omega_preproc.rst b/doc/source/omega_preproc.rst new file mode 100644 index 00000000..e96abec9 --- /dev/null +++ b/doc/source/omega_preproc.rst @@ -0,0 +1,26 @@ +omega\_preproc package +====================== + +.. automodule:: omega_preproc + :members: + :undoc-members: + :show-inheritance: + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + omega_preproc.alpha_package_costs + +Submodules +---------- + +omega\_preproc.context\_aeo module +---------------------------------- + +.. automodule:: omega_preproc.context_aeo + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/setup.rst b/doc/source/setup.rst new file mode 100644 index 00000000..552eb49d --- /dev/null +++ b/doc/source/setup.rst @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/test_omega2.rst b/doc/source/test_omega2.rst new file mode 100644 index 00000000..6d2f0010 --- /dev/null +++ b/doc/source/test_omega2.rst @@ -0,0 +1,7 @@ +test\_omega2 module +=================== + +.. automodule:: test_omega2 + :members: + :undoc-members: + :show-inheritance: