docs: cli reference (#60)

* docs: cli reference added cli arguments to docs * update workflow and api reference * Removed 'Python objects' from API reference
GreenScheduler · Aug 8, 2023 · ccbb8b9 · ccbb8b9
1 parent 43c18fa
commit ccbb8b9
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 125 deletions.
diff --git a/.github/workflows/docs-build-deploy.yml b/.github/workflows/docs-build-deploy.yml
@@ -11,6 +11,8 @@ jobs:
     steps:
     - uses: actions/checkout@v3
     - uses: actions/setup-python@v3
+    - name: Install cats 
+      run: python3 -m pip install .
     - run: |
         pip install -r docs/docs-requirements.txt
     - name: Build sphinx docs

diff --git a/docs/docs-requirements.txt b/docs/docs-requirements.txt
@@ -1,4 +1,5 @@
 sphinx
+sphinx-argparse
 ghp-import
 renku-sphinx-theme
 sphinx_copybutton
diff --git a/docs/source/api-reference.rst b/docs/source/api-reference.rst
@@ -23,16 +23,16 @@ Modules
 .. automodule:: cats.__main__
     :members:
 
-``cats.api_interface``
-^^^^^^^^^^^^^^^^^^^^^^
+``cats.CI_api_interface``
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: cats.api_interface
+.. automodule:: cats.CI_api_interface
     :members:
 
-``cats.api_query``
-^^^^^^^^^^^^^^^^^^
+``cats.CI_api_query``
+^^^^^^^^^^^^^^^^^^^^^
 
-.. automodule:: cats.api_query
+.. automodule:: cats.CI_api_query
     :members:
 
 ``cats.carbonFootprint``
@@ -47,124 +47,10 @@ Modules
 .. automodule:: cats.forecast
     :members:
 
-``cats.parsedata``
-^^^^^^^^^^^^^^^^^^
-
-.. automodule:: cats.parsedata
-    :members:
-
-``cats.timeseries_conversion``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. automodule:: cats.timeseries_conversion
-    :members:
-
-
-Python objects
---------------
-
-
-
-
-In ``cats.__init__``
-^^^^^^^^^^^^^^^^^^^^
-
-Functions
-"""""""""
-
-.. autosummary::
-
-   cats.__init__.findtime
-   cats.__init__.parse_arguments
-   cats.__init__.validate_jobinfo
-   cats.__init__.main
-
-
-In ``cats.__main__``
-^^^^^^^^^^^^^^^^^^^^
-
-n/a
-
-
-In ``cats.api_interface``
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Functions
-"""""""""
-
-.. autosummary::
-
-   cats.api_interface.ciuk_request_url
-   cats.api_interface.ciuk_parse_response_data
-
-Variables and constants
-"""""""""""""""""""""""
-
-.. autosummary::
-
-   cats.api_interface.APIInterface
-   cats.api_interface.API_interfaces
 
-In ``cats.api_query``
-^^^^^^^^^^^^^^^^^^^^^
-
-Functions
-"""""""""
-
-.. autosummary::
-
-   cats.api_query.get_tuple
-
-
-In ``cats.carbonFootprint``
+``cats.optimise_starttime``
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Classes
-"""""""
-
-.. autosummary::
-
-   cats.carbonFootprint.greenAlgorithmsCalculator
-
-Variables and constants
-"""""""""""""""""""""""
-
-.. autosummary::
-
-   cats.carbonFootprint.Estimates
-
-
-In ``cats.forecast``
-^^^^^^^^^^^^^^^^^^^^
-
-Classes
-"""""""
-
-.. autosummary::
-
-   cats.forecast.CarbonIntensityPointEstimate
-   cats.forecast.CarbonIntensityAverageEstimate
-   cats.forecast.WindowedForecast
-
-
-In ``cats.parsedata``
-^^^^^^^^^^^^^^^^^^^^^
-
-Functions
-"""""""""
-
-.. autosummary::
-
-   cats.parsedata.avg_carbon_intensity
-
-
-In ``cats.timeseries_conversion``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Functions
-"""""""""
-
-.. autosummary::
+.. automodule:: cats.optimise_starttime
+    :members:
 
-   cats.timeseries_conversion.check_duration
-   cats.timeseries_conversion.get_lowest_carbon_intensity
diff --git a/docs/source/cli-reference.rst b/docs/source/cli-reference.rst
@@ -3,6 +3,8 @@
 Command-line (CLI) reference
 ============================
 
-.. TODODOCS
 
-Coming soon...
+.. argparse::
+  :module: cats
+  :func: parse_arguments
+  :prog: cats
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -41,6 +41,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
+    "sphinxarg.ext",
     "sphinx.ext.coverage",
     "sphinx.ext.napoleon",
     "sphinx_copybutton",