TNO Intern

Commit de7d092a authored by Arjo Segers's avatar Arjo Segers
Browse files

Changes in documentation and doc strings such that autodoc can import the cso and utopya packages.

parent 36349836

doc/source/conf.py

+5 −3
Original line number Diff line number Diff line
@@ -12,8 +12,10 @@ 
#

import os

import sys



sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "py")))

#

sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src")))

sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src", "utopya")))

sys.path.insert(0, os.path.abspath(os.path.join(os.pardir, os.pardir, "src", "cso")))





# -- Project information -----------------------------------------------------
@@ -23,7 +25,7 @@ copyright = "2020-2025, Arjo Segers" 
author = "Arjo Segers"



# The full version, including alpha/beta/rc tags

release = "v2.11"

release = "v2.12"





# -- General configuration ---------------------------------------------------

doc/source/history.rst

+3 −0
Original line number Diff line number Diff line
@@ -116,6 +116,9 @@ A summary of the versions and changes. 
* | *v2.11*

  | Support inquiry and download from NASA EarthData archive.

  

* | *v2.12*

  | Support running in Python virtual environment.





To be included

==============

doc/source/pymod-cso_catalogue.rst

+1 −1
Original line number Diff line number Diff line 
.. Documentation for module.



.. Import documentation from ".py" file:

.. automodule:: cso_catalogue

.. automodule:: cso.cso_catalogue

doc/source/pymod-cso_colhub.rst

+1 −1
Original line number Diff line number Diff line 
.. Documentation for module.



.. Import documentation from ".py" file:

.. automodule:: cso_colhub

.. automodule:: cso.cso_colhub

doc/source/pymod-cso_colocate.rst

+1 −1
Original line number Diff line number Diff line 
.. Documentation for module.



.. Import documentation from ".py" file:

.. automodule:: cso_colocate

.. automodule:: cso.cso_colocate