adding in auto documentation

Author: max-anu

docs/_templates/custom-class-template.rst

@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

docs/_templates/custom-module-template.rst

@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: custom-module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

docs/api.rst

@@ -3,9 +3,12 @@ API
 
 .. autosummary::
    :toctree: generated
+   :template: custom-module-template.rst
+   :recursive:
 
-   earth
-   utils
+   accessvis
+   accessvis.earth
+   accessvis.utils
 
 
 

docs/conf.py

@@ -16,11 +16,10 @@
 
 
 # -- Project information -----------------------------------------------------
-
-project = "Basic Sphinx Example Project"
-copyright = "2022, Read the Docs core team"
-author = "Read the Docs core team"
-
+project = 'ACCESS-Vis'
+copyright = '2024, Owen Kaluza'
+author = 'Owen Kaluza'
+release = 'v0.1'
 
 # -- General configuration ---------------------------------------------------
 # -- General configuration
@@ -32,13 +31,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.intersphinx",
 ]
-
-intersphinx_mapping = {
-    "rtd": ("https://docs.readthedocs.io/en/stable/", None),
-    "python": ("https://docs.python.org/3/", None),
-    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
-}
-intersphinx_disabled_domains = ["std"]
+autosummary_generate = True
 
 templates_path = ["_templates"]
 

docs/index.rst

@@ -1,19 +1,21 @@
-.. include:: ../README.rst
+Welcome to the AccessVis documentation!
+=======================================
+
+Visualisation examples and resources, including open-source 3D vis for ACCESS-NRI releases
+
+This repository is intended as a resource for complex visualisation tasks using ACCESS models and other related data sources.
+
+What this space for published source code for our released visualisations which will be added here as soon as tested and ready for public release.
+
+Included the python module 'accessvis' which can be installed from here with `python -m pip install --editable .`
+
+See also the included `install.sh` to set up the jupyter kernels for running in ARE on gadi.
 
-Welcome to Lumache's documentation!
-===================================
 
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
-that creates recipes mixing random ingredients.
-It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
-and offers a *simple* and *intuitive* API.
 
 Check out the :doc:`usage` section for further information, including
 how to :ref:`installation` the project.
 
-.. note::
-
-   This project is under active development.
 
 Contents
 --------

docs/usage.rst

@@ -1,29 +1,19 @@
 Usage
 =====
 
+Example usage
+
+>>> import accessvis
+>>> accessvis.plot_earth()
+
 .. _installation:
 
 Installation
 ------------
 
-To use Lumache, first install it using pip:
-
-.. code-block:: console
-
-   (.venv) $ pip install lumache
-
-Creating recipes
-----------------
+AccessVis is available on gadi using the latest `med-condaenv` environment.
 
-To retrieve a list of random ingredients,
-you can use the ``accessvis.plot_earth()`` function:
 
-.. autofunction:: accessvis.plot_earth
-
-
-
-For example:
-
->>> import accessvis
->>> accessvis.plot_earth()
+To install AccessVis locally, first install it using pip:
 
+   ``python -m pip install --editable .``