FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit 35cf8669 authored by L. Bower's avatar L. Bower
Browse files

more doc work

parent 84a1760e
No related branches found
No related tags found
No related merge requests found
Overview
========
.. _general_overview:
Was thinking high-level overview of the modulkes and how they interact/what they do. general schematics of the workflow
......@@ -6,7 +6,8 @@
Installation
============
.. _installation_label:
.. _installation:
To install the package, do stuff
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>
subthing
========
.. _coordinator:
Full-depth coordinator docs
.. _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
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
.. 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>`
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment