Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions docs/_templates/autosummary/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}

2 changes: 1 addition & 1 deletion docs/_templates/function.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
.. currentmodule:: cfdm
.. default-role:: obj

.. autofunction:: {{ fullname }}
.. autofunction:: {{ objname }}
22 changes: 11 additions & 11 deletions docs/source/api_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ Version |release| for version |version| of the CF conventions.

* **Construct classes**

* :ref:`cfdm.Field <cfdm-Field>`
* :ref:`cfdm.Domain <cfdm-Domain>`
* :ref:`cfdm.AuxiliaryCoordinate <cfdm-AuxiliaryCoordinate>`
* :ref:`cfdm.CellMeasure <cfdm-CellMeasure>`
* :ref:`cfdm.CellMethod <cfdm-CellMethod>`
* :ref:`cfdm.Coordinatereference <cfdm-Coordinatereference>`
* :ref:`cfdm.DimensionCoordinate <cfdm-DimensionCoordinate>`
* :ref:`cfdm.DomainAncillary <cfdm-DomainAncillary>`
* :ref:`cfdm.DomainAxis <cfdm-DomainAxis>`
* :ref:`cfdm.FieldAncillary <cfdm-FieldAncillary>`
* :py:class:`cfdm.Field`
* :py:class:`cfdm.Domain`
* :py:class:`cfdm.AuxiliaryCoordinate`
* :py:class:`cfdm.CellMeasure`
* :py:class:`cfdm.CellMethod`
* :py:class:`cfdm.Coordinatereference`
* :py:class:`cfdm.DimensionCoordinate`
* :py:class:`cfdm.DomainAncillary`
* :py:class:`cfdm.DomainAxis`
* :py:class:`cfdm.FieldAncillary`

.. toctree::
:maxdepth: 2

Expand Down
42 changes: 0 additions & 42 deletions docs/source/class/cfdm.NetCDFIndexer.rst

This file was deleted.

99 changes: 0 additions & 99 deletions docs/source/class/cfdm.NumpyArray.rst

This file was deleted.

12 changes: 8 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def _get_date():
# -- General configuration ----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = "2.3.1"
needs_sphinx = "7.0.0"

# rst_prolog = """
# .. |CF| replace:: """+_get_cf_version()+"""
Expand All @@ -96,10 +96,16 @@ def _get_date():
"sphinxcontrib.spelling",
]


# Boolean indicating whether to scan all found documents for
# autosummary directives, and to generate stub pages for each
# (http://sphinx-doc.org/latest/ext/autosummary.html)
autosummary_generate = True

# SLB, DH NOTE: we don't want to generate these stubs as they use templates
# from _templates/autosummary which override our custom sub-section lists
# in our class/*.rst reference files, which we want to use directly! So this
# flag setting is crucial.
autosummary_generate = False

# Both the class’ and the __init__ method’s docstring are concatenated
# and inserted.
Expand All @@ -116,8 +122,6 @@ def _get_date():
# This value is a list of autodoc directive flags that should be
# automatically applied to all autodoc
# directives. (http://sphinx-doc.org/latest/ext/autodoc.html)
# autodoc_default_flags = [
# 'members', 'inherited-members', 'show-inheritance'] # deprecated
autodoc_default_options = {
"members": True,
"inherited-members": True,
Expand Down
8 changes: 4 additions & 4 deletions docs/source/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Mathematical operations
:toctree: function/
:template: function.rst

cf.atol
cf.rtol
cfdm.atol
cfdm.rtol

Resource management
-------------------
Expand All @@ -42,8 +42,8 @@ Resource management
:toctree: function/
:template: function.rst

cf.configuration
cf.chunksize
cfdm.configuration
cfdm.chunksize

Miscellaneous
-------------
Expand Down
6 changes: 3 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ properly, although the defaults are usually sufficient.
**conda**
---------

The cfdm package is in the :ref:`conda-forge
<https://anaconda.org/conda-forge/cfdm>` conda channel. To install
cfdm with all of its :ref:`dependencies <Dependencies>` run
The cfdm package is in the
`conda-forge <https://anaconda.org/conda-forge/cfdm>`_ conda channel.
To install cfdm with all of its :ref:`dependencies <Dependencies>` run:

.. code-block:: console
:caption: *Install with conda.*
Expand Down
5 changes: 3 additions & 2 deletions docs/source/tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -548,8 +548,9 @@ properties may be removed with the `~Field.clear_properties` and
'standard_name': 'air_temperature',
'units': 'K'}

All of the methods related to the properties are listed :ref:`here
<Field-Properties>`.

All of the methods related to the properties are listed
:ref:`here <Field-Properties>`.

----

Expand Down
5 changes: 1 addition & 4 deletions release_docs
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ fi
version=`python -c "import cfdm; print(cfdm.__version__)"`

sphinx_version=`python -c "import sphinx; print(sphinx.__version__)"`
if [[ $sphinx_version != "2.4.5" ]] ; then
echo "ERROR: Must (sadly) use sphinx version 2.4.5. Got $sphinx_version"
exit 3
fi
echo "NOTE: Using sphinx version: $sphinx_version"

if [[ $1 = "latest" ]] ; then
dir=$PWD/docs
Expand Down
Loading