Commit 78e9e79e authored by BorjaEst's avatar BorjaEst
Browse files

Merge branch '26-improve-doc-format-on-superior-index'

parents 1dc987b6 becd086d
...@@ -47,8 +47,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] ...@@ -47,8 +47,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
# html_theme = 'sphinx_rtd_theme'
html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
......
=========================================
o3skim
=========================================
.. rubric:: Data skimming for ozone assessment. .. rubric:: Data skimming for ozone assessment.
**o3skim** is an open source project and Python package that provides the **o3skim** is an open source project and Python package that provides the
...@@ -9,10 +6,9 @@ simplify and speed up ozone data transfer and plot. ...@@ -9,10 +6,9 @@ simplify and speed up ozone data transfer and plot.
.. _netCDF: http://www.unidata.ucar.edu/software/netcdf .. _netCDF: http://www.unidata.ucar.edu/software/netcdf
Documentation
-------------
**Getting started** Getting started
=========================================
* Which :doc:`getting_started/prerequisites` you need to start. * Which :doc:`getting_started/prerequisites` you need to start.
* How to :doc:`getting_started/build` your o3skim container. * How to :doc:`getting_started/build` your o3skim container.
...@@ -30,7 +26,8 @@ Documentation ...@@ -30,7 +26,8 @@ Documentation
getting_started/cli getting_started/cli
**User guide** User guide
=========================================
* Create your :doc:`user_guide/source-file` to point what to skim. * Create your :doc:`user_guide/source-file` to point what to skim.
* Learn how to skim by reading the :doc:`user_guide/o3skim` * Learn how to skim by reading the :doc:`user_guide/o3skim`
...@@ -44,7 +41,8 @@ Documentation ...@@ -44,7 +41,8 @@ Documentation
user_guide/o3skim user_guide/o3skim
**Developer guide** Developer guide
=========================================
* How to do a :doc:`dev_guide/local-install` * How to do a :doc:`dev_guide/local-install`
* How to run and create new :doc:`dev_guide/tests` * How to run and create new :doc:`dev_guide/tests`
...@@ -59,7 +57,10 @@ Documentation ...@@ -59,7 +57,10 @@ Documentation
See also See also
-------- =========================================
Indices and tables
---------------------
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
...@@ -67,7 +68,7 @@ See also ...@@ -67,7 +68,7 @@ See also
Authors Authors
------- ---------------------
- `@V.Kozlov <https://git.scc.kit.edu/eo9869>`_ - TBD - `@V.Kozlov <https://git.scc.kit.edu/eo9869>`_ - TBD
- `@T.Kerzenmacher <https://git.scc.kit.edu/px5501>`_ - TBD - `@T.Kerzenmacher <https://git.scc.kit.edu/px5501>`_ - TBD
...@@ -75,6 +76,6 @@ Authors ...@@ -75,6 +76,6 @@ Authors
Acknowledgements Acknowledgements
---------------- ---------------------
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment