Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to Sphinx an ReadtheDocs setup #924

Merged
merged 20 commits into from
Jun 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"

# Build documentation in the doc/ directory with Sphinx
sphinx:
configuration: doc/source/conf.py

# Optionally declare the Python requirements required to build your docs
python:
install:
- method: pip
path: .
extra_requirements:
- doc
# - requirements: requirements.txt
18 changes: 9 additions & 9 deletions doc/source/advanced_docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,9 +163,9 @@ gridpath.project.operations.fuel_burn
.. automodule:: gridpath.project.operations.fuel_burn
:members: add_model_components

gridpath.project.operations.recs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.recs
gridpath.project.operations.energy_target_contributions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.project.operations.energy_target_contributions
:members: add_model_components

gridpath.project.operations.tuning_costs
Expand Down Expand Up @@ -343,13 +343,13 @@ Transmission Hurdle Rates
If the transmission hurdle rates feature is enabled, the following modules
are also included:

gridpath.transmission.operations.costs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.transmission.operations.costs
gridpath.transmission.operations.hurdle_costs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.transmission.operations.hurdle_costs

gridpath.objective.transmission.aggregate_operational_costs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.objective.transmission.aggregate_operational_costs
gridpath.objective.transmission.aggregate_hurdle_costs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: gridpath.objective.transmission.aggregate_hurdle_costs



Expand Down
5 changes: 2 additions & 3 deletions doc/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ Running a Scenario
gridpath.run_scenario
=====================
.. automodule:: gridpath.run_scenario
:members: main, parse_arguments, ScenarioStructure, run_scenario,
run_optimization, create_and_solve_problem,
create_abstract_model,
:members: main, parse_arguments, run_scenario, run_optimization_for_subproblem,
create_and_solve_problem, create_abstract_model,
load_scenario_data, create_problem_instance, fix_variables, solve


Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@

# General information about the project.
project = "GridPath"
copyright = "2019, Blue Marble Analytics LLC"
copyright = "2016-2022, Blue Marble Analytics LLC"
author = "Blue Marble Analytics LLC"

# The version info for the project you're documenting, acts as replacement for
Expand Down
4 changes: 2 additions & 2 deletions doc/source/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,13 @@ Fuel Inputs (OPTIONAL)
Fuel Characteristics
********************

.. automodule:: db.csvs_test_examples.fuels.project_fuels.doc
.. automodule:: db.csvs_test_examples.fuels.fuel_chars.doc


Fuel Prices
***********

.. automodule:: db.csvs_test_examples.fuels.project_fuel_prices.doc
.. automodule:: db.csvs_test_examples.fuels.fuel_prices.doc

*******************
Reserves (OPTIONAL)
Expand Down
4 changes: 2 additions & 2 deletions doc/temp/optional_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ Transmission Hurdle Rates
Whether or not to apply hurdle rates on transmission line flows.

Feature modules include:
.. automodule:: gridpath.transmission.operations.costs
.. automodule:: gridpath.transmission.operations.hurdle_costs
:members:
.. automodule:: gridpath.objective.transmission.aggregate_operational_costs
.. automodule:: gridpath.objective.transmission.aggregate_hurdle_costs
:members:


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def add_model_components(m, d, scenario_directory, subproblem, stage):
+-------------------------------------------------------------------------+
| Optional Input Params |
+=========================================================================+
| | :code:`avl_exog_cap_derate` |
| | :code:`avl_exog_cap_derate` |
| | *Defined over*: :code:`AVL_EXOG_OPR_TMPS` |
| | *Within*: :code:`NonNegativeReals` |
| | *Default*: :code:`1` |
Expand Down
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,8 @@

# Set up extras
extras_doc = [
"Sphinx==4.0.2",
"sphinx-argparse==0.2.5",
"numpy==1.21.5" # temporarily require v1.21.5 because v1.22 is not available on
# readthedocs and build fails otherwise
"Sphinx==5.0.1",
"sphinx-argparse==0.3.1",
]
extras_ui = [
"eventlet==0.31.0", # Async mode for SocketIO
Expand Down
2 changes: 1 addition & 1 deletion version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.13.0"
__version__ = "v0.13.0"