diff --git a/docs/_source/general_overview.rst b/docs/_source/general_overview.rst new file mode 100644 index 0000000000000000000000000000000000000000..0584396787cacb6b867620cc5418014a8137d642 --- /dev/null +++ b/docs/_source/general_overview.rst @@ -0,0 +1,7 @@ +Overview +======== + +.. _general_overview: + +Was thinking high-level overview of the modulkes and how they interact/what they do. general schematics of the workflow + diff --git a/docs/_source/installation.rst b/docs/_source/installation.rst index 8f221c34b852d9efae1f8afdd18569779d3f88d9..42d7cdbb2729621d09100e3444a4e63275359a15 100644 --- a/docs/_source/installation.rst +++ b/docs/_source/installation.rst @@ -6,7 +6,8 @@ Installation ============ -.. _installation_label: +.. _installation: + To install the package, do stuff diff --git a/docs/_source/package_overview.rst b/docs/_source/package_overview.rst new file mode 100644 index 0000000000000000000000000000000000000000..19a1d0e5dc8c95a61568e2dc382911e6e7f2e2ce --- /dev/null +++ b/docs/_source/package_overview.rst @@ -0,0 +1,13 @@ +Package Overview +================ + +.. _package_overview: + +Links to specific package docs, with full-depth docs + + +:ref:`Home<home>` + +.. toctree:: + Coordinator <packages/coordinator> + Met Processing <packages/met_processing> diff --git a/docs/_source/packages/coordinator.rst b/docs/_source/packages/coordinator.rst new file mode 100644 index 0000000000000000000000000000000000000000..93509eb6635d2b995824c5544f98e43f2f6f1db1 --- /dev/null +++ b/docs/_source/packages/coordinator.rst @@ -0,0 +1,7 @@ +subthing +======== + +.. _coordinator: + +Full-depth coordinator docs + diff --git a/docs/_source/packages/met_processing.rst b/docs/_source/packages/met_processing.rst new file mode 100644 index 0000000000000000000000000000000000000000..97505ed256ed40bc6966c485f336d1f653b131f1 --- /dev/null +++ b/docs/_source/packages/met_processing.rst @@ -0,0 +1,18 @@ +.. _met_processing: + +Met Processing +============== + +Full-depth Met Processing docs + +Overview +-------- + +The Met Processing package processes Met data supplied by the UK Met Office (UKMETO) + +.. autosummary:: + met_processing.common + met_processing.met_extraction + met_processing.post_processing + met_processing.runner + diff --git a/docs/_templates/readme.txt b/docs/_templates/readme.txt new file mode 100644 index 0000000000000000000000000000000000000000..80a199c5a79d2d036b462bd29537f82f6cdaa295 --- /dev/null +++ b/docs/_templates/readme.txt @@ -0,0 +1,5 @@ +these custom template files are to make sphinx autodoc continue to create docs for all documentation recursivly. +Taken from: +https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion +see also: +https://github.com/sphinx-doc/sphinx/issues/7912 \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index da8fe331fbb6d260c107b2b64f91bc3e9a527516..5c99ac10705c0b3253c0e399dbbbef742ac851c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,7 @@ -.. ews-plotting documentation master file, created by - sphinx-quickstart on Thu May 25 13:28:43 2023. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. -Welcome to ews-plotting's documentation! +.. _home: + +Welcome to the EWS documentation! ======================================== for sections @@ -19,10 +17,18 @@ for paragraphs """""""""""""" .. toctree:: + Home <self> + Installation <_source/installation> + General Overview <_source/general_overview> + Package overview <_source/package_overview> + + +.. toctree:: + :caption: APIs + :name: apitoc :hidden: + :titlesonly: - Home page <self> - Installation <_source/installation> coordinator API <_autosummary/coordinator> plotting API <_autosummary/plotting> post processing API <_autosummary/ews_postprocessing> @@ -49,5 +55,5 @@ Installation instructions A quickstart on installation can be found in: :doc:`_source/installation`. -And here I am refering to it again but using a page :ref:`label<installation_label>` +And here I am referring to it again but using a page :ref:`label<installation>`