FAQ | This is a LIVE service | Changelog

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

minor doc changes

parent d82fdef4
No related branches found
No related tags found
No related merge requests found
......@@ -2,16 +2,17 @@
.. _home:
Welcome to the EWS documentation!
========================================
=================================
This documentation is for collaborators in the Wheat Rust Detection and Early Warning System (EWS) to deploy and run
the pipeline currently running at the University of Cambridge.
.. toctree::
:maxdepth: 1
Home <self>
Installation <_source/installation>
General Overview <_source/general_overview>
Package overview <_source/package_overview>
Installation <_source/installation>
.. toctree::
......@@ -29,43 +30,4 @@ Welcome to the EWS documentation!
epimodel API <_autosummary/EpiModel>
advisory API <_autosummary/AdvisoryBuilder>
.. admonition:: Box thingy
This is a box thingy
Example of inline code links
----------------------------
this is is a load of ``text`` that has ``plotting.common.utils`` this function in it.
and this should be on a new line
Note that to link to a method: :meth:`~met_processing.runner.common.job_runner.run_extraction`
or a function: :func:`~met_processing.common.met_field_name_constants_parser.parse_constants_file`
or a class :class:`~met_processing.common.MetDataConstants.MetDataConstants`, the target concerned has to have docs,
otherwise there will be no file to generate a link to
note that you can also link to :class:`met_processing.met_extraction` modules, but you use the :class: markup for some
reason
The code blocks above also work in the docstrings.
.. autosummary::
plotting.common.utils.build_standard_depo_diseases
ews_postprocessing.deposition.NAME_to_csv.NAMEToCSV
Installation instructions
-------------------------
A quickstart on installation can be found in: :doc:`_source/installation`.
And here I am referring to it again but using a page :ref:`label<installation>`
Example image
.. image:: _images/depo.png
:scale: 50 %
:alt: alternate text
:align: right
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