FAQ
| This is a
LIVE
service |
Changelog
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
ews-coordinator
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Package Registry
Container Registry
Operate
Terraform modules
Analyze
Contributor analytics
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Gilligan Lab for Epidemiology and Modelling
Wheat rusts
ews-coordinator
Commits
84a1760e
Commit
84a1760e
authored
1 year ago
by
L. Bower
Browse files
Options
Downloads
Patches
Plain Diff
more doc work for coordinator
parent
d7b7eecc
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/_source/installation.rst
+12
-0
12 additions, 0 deletions
docs/_source/installation.rst
docs/_static/css/extra.css
+4
-0
4 additions, 0 deletions
docs/_static/css/extra.css
docs/conf.py
+4
-0
4 additions, 0 deletions
docs/conf.py
docs/index.rst
+27
-3
27 additions, 3 deletions
docs/index.rst
with
47 additions
and
3 deletions
docs/_source/installation.rst
0 → 100644
+
12
−
0
View file @
84a1760e
.. 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
This diff is collapsed.
Click to expand it.
docs/_static/css/extra.css
0 → 100644
+
4
−
0
View file @
84a1760e
.wy-nav-content
{
max-width
:
1200px
!important
;
.not_full_screen
{
background
:
red
;
width
:
100%
;
height
:
700px
;}
\ No newline at end of file
This diff is collapsed.
Click to expand it.
docs/conf.py
+
4
−
0
View file @
84a1760e
...
...
@@ -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
This diff is collapsed.
Click to expand it.
docs/index.rst
+
27
−
3
View file @
84a1760e
...
...
@@ -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 table
s
==================
Example of inline code link
s
----------------------------
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>`
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment