FAQ | This is a LIVE service | Changelog

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

more doc work for coordinator

parent d7b7eecc
No related branches found
No related tags found
No related merge requests found
.. 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.
Installation
============
.. _installation_label:
To install the package, do stuff
.wy-nav-content {
max-width: 1200px !important;
.not_full_screen {background: red;width: 100%;height: 700px;}
\ No newline at end of file
......@@ -55,6 +55,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally
html_css_files = ["readthedocs-custom.css"] # Override some CSS settings
# html_theme = 'alabaster'
html_static_path = ['_static']
# # This is the expected signature of the handler for this event, cf doc
# def autodoc_skip_member_handler(app, what, name, obj, skip, options):
......@@ -68,3 +69,6 @@ html_css_files = ["readthedocs-custom.css"] # Override some CSS settings
# # Connect the autodoc-skip-member event from apidoc to the callback
# app.connect('autodoc-skip-member', autodoc_skip_member_handler)
def setup(app):
app.add_css_file('css/extra.css')
\ No newline at end of file
......@@ -6,24 +6,48 @@
Welcome to ews-plotting's documentation!
========================================
for sections
============
for subsections
---------------
for subsubsections
^^^^^^^^^^^^^^^^^^
for paragraphs
""""""""""""""
.. toctree::
:hidden:
Home page <self>
Installation <_source/installation>
coordinator API <_autosummary/coordinator>
plotting API <_autosummary/plotting>
post processing API <_autosummary/ews_postprocessing>
met processing processing API <_autosummary/met_processing>
source gen API <_autosummary/source_gen>
.. admonition:: Box thingy
This is a box thingy
Indices and tables
==================
Example of inline code links
----------------------------
this is is a load of ``text`` that has ``plotting.common.utils`` this function in it
this is is a load of ``text`` that has ``plotting.common.utils`` this function in it.
and this should be on a new line
.. 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 refering to it again but using a page :ref:`label<installation_label>`
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