Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FB] [PI-3478] Metadata and cube maths documentation #3869

Merged
Merged
Show file tree
Hide file tree
Changes from 26 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/iris/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def autolog(message):
"menu_links_name": "Support",
"menu_links": [
(
'<i class="fa fa-github fa-fw"></i> Source Code',
'<i class="fa fa-github fa-fw"></i> Source code',
"https://github.com/SciTools/iris",
),
(
Expand All @@ -221,7 +221,7 @@ def autolog(message):
"https://groups.google.com/forum/#!forum/scitools-iris-dev",
),
(
'<i class="fa fa-question fa-fw"></i> StackOverflow For "How do I?"',
'<i class="fa fa-question fa-fw"></i> StackOverflow for "How do I?"',
"https://stackoverflow.com/questions/tagged/python-iris",
),
(
Expand Down Expand Up @@ -271,3 +271,15 @@ def autolog(message):
message="Matplotlib is currently using agg, which is a"
" non-GUI backend, so cannot show the figure.",
)


# -- numfig options (built-in) ------------------------------------------------
# Enable numfig.
numfig = True

numfig_format = {
"code-block": "Example %s",
"figure": "Figure %s",
"section": "Section %s",
"table": "Table %s",
}
4 changes: 2 additions & 2 deletions docs/iris/src/developers_guide/gitwash/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _using-git:

Working with *iris* source code
================================================
Working with Iris source code
=============================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/iris/src/developers_guide/pulls.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _pr_check:


Pull request check List
Pull request check list
***********************

A pull request to a SciTools project master should be ready to merge into the
Expand Down
24 changes: 24 additions & 0 deletions docs/iris/src/further_topics/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Introduction
============

Some specific areas of Iris may require further explanation or a deep dive
into additional detail above and beyond that offered by the
:ref:`User guide <user_guide_introduction>`.

This section provides a collection of additional material on focused topics
that may be of interest to the more advanced or curious user.

.. hint::

If you wish further documentation on any specific topics or areas of Iris
that are missing, then please let us know by raising a `GitHub Documentation Issue`_
on `SciTools/Iris`_.


* :doc:`metadata`
* :doc:`lenient_metadata`
* :doc:`lenient_maths`


.. _GitHub Documentation Issue: https://github.com/SciTools/iris/issues/new?assignees=&labels=New%3A+Documentation%2C+Type%3A+Documentation&template=documentation.md&title=
.. _SciTools/iris: https://github.com/SciTools/iris
9 changes: 9 additions & 0 deletions docs/iris/src/further_topics/lenient_maths.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _lenient maths:

******************
Lenient cube maths
******************

.. todo:: Add summary of section contents here.

*Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean vitae tortor maximus, suscipit sapien ut, consequat ante. Pellentesque lacinia efficitur neque, sit amet ultricies libero pharetra sit amet. Ut nisl magna, finibus nec dictum quis, eleifend aliquam justo. Aenean sed quam diam. In iaculis felis a odio vulputate, placerat pretium arcu elementum. Quisque commodo et eros id pellentesque. Quisque aliquam tortor eu ex mollis, sit amet pretium sapien vestibulum. Aenean fermentum metus velit, vitae dignissim urna aliquam sed. Etiam laoreet sit amet felis eget ullamcorper.*
Loading