contributing.rst

Contributing to These Docs

Additions, improvements, and corrections to these docs are always welcome.

The quickest way to fix typos, etc. on existing pages is to use the :guilabel:`Edit on GitHub` link in the upper right corner of the page to get to the online editor for the page on GitHub.

For more substantial work, and to add new pages, the instructions below explain how to:

• clone the repository from GitHub
• set up a conda environment in which you can build the docs locally instead of having to push commits to GitHub to trigger a build on readthedocs.org
• build the docs with your changes, and preview them in Firefox

Getting the Repo

Clone the MOAD documentation repository from GitHub with:

$ git clone [email protected]:UBC-MOAD/docs.git

or copy the URI (the stuff after :command:`git clone` above) from the :guilabel:`Code` button on the repository page.

Note

The :command:`git clone` command above assumes that your are connecting to GitHub using SSH. If it fails, please follow the instructions in our :ref:`SecureRemoteAccess` docs to set up your SSH keys and :ref:`CopyYourPublicSshKeyToGitHub`.

Docs Build Environment

Setting up an isolated docs build environment using Conda is recommended. Assuming that you have :ref:`Installed Miniforge <InstallingMiniforge>`, you can create and activate an environment called moad-docs that will have all of the Python packages necessary for building the documentation with the commands:

$ cd docs
$ conda env create -f environment.yaml
$ conda activate moad-docs

To deactivate the environment use:

(moad-docs)$ conda deactivate

Note

If you are using a version of :command:`conda` older than 4.4.0, the commands to activate and deactivate the environment are:

$ source activate moad-docs

and

(moad-docs)$ source deactivate

You can check what version of :command:`conda` you are using with :command:`conda --version`.

Building and Previewing the Documentation

The MOAD documentation is written in reStructuredText and converted to HTML using Sphinx. Creating a :ref:`MOAD-DocsBuildEnvironment` as described above includes the installation of Sphinx. Building the documentation is driven by the :file:`docs/Makefile`. With your moad-docs environment activated, use:

(moad-docs)$ make clean html

to do a clean build of the documentation. The output looks something like:

Removing everything under '_build'...
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
Writing evaluated template result to /media/doug/warehouse/MOAD/docs/_build/html/_static/nbsphinx-code-cells.css
loading intersphinx inventory 'moadtools' from https://ubc-moad-tools.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'nemocmd' from https://nemo-cmd.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'salishseacmd' from https://salishseacmd.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'salishseadocs' from https://salishsea-meopar-docs.readthedocs.io/en/latest/objects.inv ...
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 24 source files that are out of date
updating environment: [new config] 24 added, 0 changed, 0 removed
reading sources... [100%] zzz_archival_docs/index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files...
Writing evaluated template result to /media/doug/warehouse/MOAD/docs/_build/html/_static/language_data.js
Writing evaluated template result to /media/doug/warehouse/MOAD/docs/_build/html/_static/basic.css
Writing evaluated template result to /media/doug/warehouse/MOAD/docs/_build/html/_static/documentation_options.js
Writing evaluated template result to /media/doug/warehouse/MOAD/docs/_build/html/_static/js/versions.js
copying static files: done
copying extra files...
copying extra files: done
copying assets: done
writing output... [100%] zzz_archival_docs/index
generating indices... done
copying linked files...
copying notebooks ...
writing additional pages... search done
copying images... [100%] segrid_edit.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.

The HTML rendering of the docs ends up in :file:`docs/_build/html/`. You can open the :file:`index.html` file in that directory tree in your browser to preview the results of the build. To preview in Firefox from the command-line you can do:

(moad-docs)$ firefox _build/html/index.html

If you have write access to the repository on GitHub, whenever you push changes to GitHub the documentation is automatically re-built and rendered at https://ubc-moad-docs.readthedocs.io/en/latest/.

Link Checking the Documentation

Use the commmand:

(midoss-docs)$ make linkcheck

to check the documentation for broken links. The output looks something like:

Removing everything under '_build'...
Running Sphinx v8.1.3
loading translations [en]... done
making output directory... done
loading intersphinx inventory 'moadtools' from https://ubc-moad-tools.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'nemocmd' from https://nemo-cmd.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'salishseacmd' from https://salishseacmd.readthedocs.io/en/latest/objects.inv ...
loading intersphinx inventory 'salishseadocs' from https://salishsea-meopar-docs.readthedocs.io/en/latest/objects.inv ...
building [mo]: targets for 0 po files that are out of date
writing output...
building [linkcheck]: targets for 24 source files that are out of date
updating environment: [new config] 24 added, 0 changed, 0 removed
reading sources... [100%] zzz_archival_docs/index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying assets: done
writing output... [100%] zzz_archival_docs/index

(          ariane: line   37) -ignored- https://github.com/UBC-MOAD/ariane-2.3.0_03
(      ssh_access: line   26) -ignored- https://www.baeldung.com/cs/ssh-intro
(      ssh_access: line  556) -ignored- https://linux.die.net/man/1/scp
(          xios-2: line   41) -ignored- https://github.com/SalishSeaCast/XIOS-2
(          xios-2: line  229) -ignored- https://github.com/SalishSeaCast/NEMO-3.6-code
(          ariane: line   25) ok        http://ariane.lagrangian.free.fr/ariane_tutorial_2.x.x_sep08.pdf
(          ariane: line   24) ok        http://ariane.lagrangian.free.fr/ariane_namelist_2.x.x_oct08.pdf
(          ariane: line   23) ok        http://ariane.lagrangian.free.fr/ariane_install_2.x.x_sep08.pdf
(          ariane: line   15) ok        http://ariane.lagrangian.free.fr/whatsariane.html
(          ariane: line   37) ok        http://ariane.lagrangian.free.fr/download.php
(python_packaging/pkg_structure: line  181) ok        https://about.readthedocs.com/?ref=readthedocs.org
(alliance-computing: line   15) ok        https://alliancecan.ca/en
(alliance-computing: line   64) ok        https://alliancecan.ca/en/services/advanced-research-computing/account-management/apply-account
(git_version_control: line   60) ok        https://brew.sh/
(          globus: line   25) ok        https://app.globus.org/file-manager
(python_packaging/pkg_structure: line   39) ok        https://bskinn.github.io/My-How-Why-Pyproject-Src/
(python_packaging/pkg_structure: line   38) ok        https://blog.ionelmc.ro/2014/05/25/python-packaging/
(zzz_archival_docs/hg_version_control: line   41) ok        https://bitbucket.org/
(python_packaging/pkg_structure: line  483) ok        https://calver.org/
(alliance-computing: line   56) ok        https://ccdb.alliancecan.ca/account_application
(python_packaging/pkg_structure: line  296) ok        https://click.palletsprojects.com/en/latest/
(          xios-2: line  423) ok        http://cfconventions.org/Data/cf-standard-names/29/build/cf-standard-name-table.html
(          vscode: line   15) ok        https://code.visualstudio.com/
(github_notebooks_readme: line    7) ok        https://commonmark.org/
(    contributing: line   13) ok        https://creativecommons.org/licenses/by/4.0/
(python_packaging/pkg_structure: line  164) ok        https://coverage.readthedocs.io/en/latest/
(   analysis_repo: line  156) ok        https://cookiecutter.readthedocs.io/en/latest/
(conda_pkg_env_mgr: line   39) ok        https://conda-forge.org/
(python_packaging/pkg_structure: line  745) ok        https://doc.pytest.org/en/latest/explanation/goodpractices.html#tests-outside-application-code
(conda_pkg_env_mgr: line   15) ok        https://docs.conda.io/en/latest/
(         jupyter: line  354) ok        https://docs.alliancecan.ca/wiki/Anaconda/en
(         jupyter: line  394) ok        https://docs.alliancecan.ca/wiki/Python#Creating_and_using_a_virtual_environment
(python_packaging/pkg_structure: line  773) ok        https://docs.github.com/en/actions
(      ssh_access: line  506) ok        https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
(    contributing: line   78) ok        https://docs.github.com/en/authentication/connecting-to-github-with-ssh
(python_packaging/pkg_structure: line   60) ok        https://docs.conda.io/projects/conda/en/latest/
(alliance-computing: line  121) ok        https://docs.alliancecan.ca/wiki/SSH_Keys#Using_CCDB
(python_packaging/pkg_structure: line  761) ok        https://docs.github.com/en/code-security/dependabot
(python_packaging/pkg_structure: line  778) ok        https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql
(git_version_control: line   22) ok        https://docs.github.com/en/get-started
(conda_pkg_env_mgr: line  206) ok        https://docs.conda.io/projects/conda/en/latest/user-guide/configuration/use-condarc.html
(    contributing: line   13) ok        https://docs.python.org/3.13/
(python_packaging/pkg_structure: line  376) ok        https://docs.readthedocs.io/en/stable/config-file/v2.html
(     bash_config: line   43) ok        https://douglatornell.github.io/2013-09-26-ubc/lessons/ref/shell.html
(oceanparcels/index: line   23) ok        https://docs.oceanparcels.org/en/latest/reference/predefined_kernels.html
(          xios-2: line  179) ok        https://en.wikipedia.org/wiki/XML
(python_packaging/pkg_structure: line  279) ok        https://docs.openstack.org/cliff/latest/
(git_version_control: line   22) ok        https://git-scm.com/book/en/v2
(git_version_control: line  151) ok        https://git-scm.com/book/en/v2/Appendix-C%3A-Git-Commands-Setup-and-Config#ch_core_editor
(          vscode: line  149) ok        https://fortls.fortran-lang.org/index.html
(git_version_control: line  213) ok        https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository
(git_version_control: line   22) ok        https://git-scm.com/doc
(git_version_control: line  127) ok        https://git-scm.com/docs/git-config
(    contributing: line  444) ok        https://git-scm.com/
(git_version_control: line   56) ok        https://git-scm.com/downloads
( getting_started: line   55) ok        https://github.com/
(       vcs_repos: line   19) ok        https://github.com/MIDOSS/
(oceanparcels/index: line   21) ok        https://github.com/OceanParcels/parcels/discussions
(     sphinx_docs: line   36) ok        https://github.com/MIDOSS/docs
(   analysis_repo: line   62) ok        https://github.com/SalishSeaCast
(          xios-2: line  315) ok        https://forge.ipsl.fr/ioserver/raw-attachment/wiki/WikiStart/XIOS_user_guide.pdf
(       vcs_repos: line   18) ok        https://github.com/SalishSeaCast/
(python_packaging/pkg_structure: line   24) ok        https://github.com/SalishSeaCast/NEMO-Cmd
(          xios-2: line   15) ok        https://forge.ipsl.fr/ioserver/wiki
(          xios-2: line  435) ok        https://github.com/SalishSeaCast/SS-run-sets/tree/main/v201702
(          xios-2: line  235) ok        https://github.com/SalishSeaCast/SS-run-sets
(          xios-2: line   41) ok        https://github.com/SalishSeaCast/XIOS-ARCH
(github_notebooks_readme: line    7) ok        https://github.com/SalishSeaCast/analysis-ben/tree/master/notebooks
( getting_started: line   55) ok        https://github.com/UBC-MOAD
(   analysis_repo: line   33) ok        https://github.com/SalishSeaCast/analysis-susan
(   analysis_repo: line  316) ok        https://github.com/SalishSeaCast/tools
(     sphinx_docs: line   36) ok        https://github.com/SalishSeaCast/docs
(       vcs_repos: line   17) ok        https://github.com/UBC-MOAD/
(   analysis_repo: line   51) ok        https://github.com/UBC-MOAD/cookiecutter-analysis-repo
(python_packaging/pkg_structure: line  296) ok        https://github.com/UBC-MOAD/Reshapr
(conda_pkg_env_mgr: line   31) ok        https://github.com/UBC-MOAD/PythonNotes/blob/main/pkgs-envs/PythonPkgsEnvsSlides-2023.ipynb
(    contributing: line   13) ok        https://github.com/UBC-MOAD/docs
(     sphinx_docs: line   79) ok        https://github.com/UBC-MOAD/PythonNotes/blob/main/sphinx-docs/SphinxDocsTutorial.ipynb
(    contributing: line   24) ok        https://github.com/UBC-MOAD/docs/workflows/sphinx-linkcheck/badge.svg
(    contributing: line   13) ok        https://github.com/UBC-MOAD/docs/issues
(    contributing: line  470) ok        https://github.com/UBC-MOAD/docs/blob/main/CONTRIBUTORS.rst
(python_packaging/pkg_structure: line  799) ok        https://github.com/UBC-MOAD/gha-workflows
(conda_pkg_env_mgr: line   39) ok        https://github.com/conda-forge/miniforge
(     sphinx_docs: line   36) ok        https://github.com/UBC-MOAD/moad_tools
(    contributing: line   13) ok        https://github.com/UBC-MOAD/docs/actions?query=workflow:sphinx-linkcheck
(python_packaging/pkg_structure: line   35) ok        https://hatch.pypa.io/latest/
(git_version_control: line  215) ok        https://github.com/github/gitignore/blob/main/Python.gitignore
(python_packaging/pkg_structure: line  202) ok        https://hatch.pypa.io/latest/config/metadata/
(         jupyter: line  423) ok        https://github.com/h5netcdf/h5netcdf
(zzz_archival_docs/hg_version_control: line   27) ok        https://hgbook.red-bean.com/
(zzz_archival_docs/hg_version_control: line   27) ok        https://hgbook.red-bean.com/read/a-tour-of-mercurial-the-basics.html
(zzz_archival_docs/hg_version_control: line   27) ok        https://hgbook.red-bean.com/read/how-did-we-get-here.html
(    contributing: line   18) ok        https://img.shields.io/badge/version%20control-git-blue.svg?logo=github
(    contributing: line   30) ok        https://img.shields.io/badge/python-3.13-blue.svg
(    contributing: line   15) ok        https://img.shields.io/badge/license-CC--BY-lightgrey.svg
(python_packaging/pkg_structure: line  419) ok        https://github.com/github/gitignore
(github_notebooks_readme: line   12) ok        https://jupyter.org/
(python_packaging/pkg_structure: line   37) ok        https://hynek.me/articles/testing-packaging/
(         jupyter: line   24) ok        https://jupyter-notebook.readthedocs.io/en/stable/
(    contributing: line   27) ok        https://img.shields.io/github/issues/UBC-MOAD/docs?logo=github
(          vscode: line  115) ok        https://marketplace.visualstudio.com/items?itemName=Digoro.Clipboard
(          vscode: line  121) ok        https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran
(          vscode: line  128) ok        https://marketplace.visualstudio.com/items?itemName=mechatroner.rainbow-csv
(      ssh_access: line   71) ok        https://learn.microsoft.com/en-ca/windows-server/administration/openssh/openssh_install_firstuse
(          vscode: line  103) ok        https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
(          vscode: line   88) ok        https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter-renderers
(          vscode: line   97) ok        https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh
(          vscode: line  109) ok        https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
(          vscode: line  140) ok        https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf
(          vscode: line   82) ok        https://marketplace.visualstudio.com/items?itemName=ms-python.python
(          vscode: line  134) ok        https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst
(github_notebooks_readme: line   12) ok        https://nbviewer.org/
(          ariane: line  195) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/ParticleTracking.ipynb
(          ariane: line  560) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/Ariane_Tracers.ipynb
(          ariane: line  787) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/Ariane_TimeRes.ipynb
(oceanparcels/index: line   24) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/OceanParcelsRecipes.ipynb
(          xios-2: line  255) ok        https://nemo-cmd.readthedocs.io/en/latest/run_description_file/3.6_yaml_file.html#output-section
(          xios-2: line   26) ok        https://nemo-cmd.readthedocs.io/en/latest/index.html#nemo-commandprocessor
(oceanparcels/index: line   19) ok        https://oceanparcels.org/
(     sphinx_docs: line   78) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/sphinx-docs/SphinxDocsTutorial.ipynb
(          python: line   20) ok        https://numpy.org/
(oceanparcels/index: line   13) ok        https://oceanparcels.org/index.html
(python_packaging/pkg_structure: line   67) ok        https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site
(python_packaging/pkg_structure: line   36) ok        https://packaging.python.org/en/latest/
(python_packaging/pkg_structure: line   53) ok        https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
(          python: line   20) ok        https://pandas.pydata.org/
(         jupyter: line  411) ok        https://pypi.org/
(conda_pkg_env_mgr: line   30) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/pkgs-envs/PythonPkgsEnvsSlides-2023.ipynb
(python_packaging/pkg_structure: line  483) ok        https://peps.python.org/pep-0440/
(oceanparcels/index: line   22) ok        https://os.copernicus.org/articles/17/1067/2021/
(python_packaging/pkg_structure: line  183) ok        https://pre-commit.com/
(    contributing: line   21) ok        https://readthedocs.org/projects/ubc-moad-docs/badge/?version=latest
(     sphinx_docs: line  183) ok        https://rhodesmill.org/brandon/2012/one-sentence-per-line/
(    contributing: line   46) ok        https://readthedocs.org/projects/ubc-moad-docs/builds/
(          python: line   51) ok        https://realpython.com/
(   analysis_repo: line  320) ok        https://salishsea-meopar-tools.readthedocs.io/en/latest/visualisation/visualization_workflows_xarray.html
(alliance-computing: line  242) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/graham.html#compilenemo-3-6-graham
(alliance-computing: line  232) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/graham.html#createworkspaceandclonerepositories
(alliance-computing: line  236) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/graham.html#installcommandprocessorpackages
(   analysis_repo: line  320) ok        https://salishsea-meopar-tools.readthedocs.io/en/latest/SalishSeaTools/index.html
(git_version_control: line  151) ok        https://salishseacast.slack.com/?redir=%2Farchives%2FCFR6VU70S
(     bash_config: line   43) ok        https://software-carpentry.org/
(python_packaging/pkg_structure: line   40) ok        https://snarky.ca/clarifying-pep-518/
(oceanparcels/index: line   20) ok        https://salishseacast.slack.com/?redir=%2Farchives%2FC02ETTPHFPX
(alliance-computing: line  236) ok        https://salishseacmd.readthedocs.io/en/latest/index.html#salishseacmdprocessor
(          xios-2: line  255) ok        https://salishseacmd.readthedocs.io/en/latest/run_description_file/3.6_yaml_file.html#output-section
(zzz_archival_docs/hg_version_control: line   75) ok        https://tortoisehg.bitbucket.io/
(python_packaging/pkg_structure: line  826) ok        https://tox.wiki/en/latest/
(    contributing: line   13) ok        https://ubc-moad-docs.readthedocs.io/en/latest/
(     sphinx_docs: line   50) ok        https://ubc-moad-docs.readthedocs.io/en/latest/sphinx_docs.html#documentation-with-sphinx
(zzz_archival_docs/hg_version_control: line   48) ok        https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/
(     sphinx_docs: line   88) ok        https://ubc-moad-tools.readthedocs.io/en/latest/pkg_development.html#moad-toolspackageddevelopment
(conda_pkg_env_mgr: line   15) ok        https://www.anaconda.com/download
(zzz_archival_docs/hg_version_control: line  248) ok        https://wiki.mercurial-scm.org/RebaseExtension
(python_packaging/pkg_structure: line  355) ok        https://www.apache.org/licenses/
(zzz_archival_docs/hg_version_control: line   27) ok        https://wiki.mercurial-scm.org/BeginnersGuides
(zzz_archival_docs/hg_version_control: line  262) ok        https://wiki.mercurial-scm.org/RebaseExtension#Scenarios
(zzz_archival_docs/hg_version_control: line  248) ok        https://wiki.mercurial-scm.org/RebaseExtension#Scenario_A
(    CONTRIBUTORS: line    7) ok        https://www.eoas.ubc.ca/~sallen/
(zzz_archival_docs/hg_version_control: line   21) ok        https://www.mercurial-scm.org/
(     sphinx_docs: line   19) ok        https://www.mathjax.org/
(zzz_archival_docs/hg_version_control: line   63) ok        https://www.mercurial-scm.org/downloads
(          globus: line   15) ok        https://www.globus.org/data-transfer
(      ssh_access: line   31) ok        https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server
(          python: line   15) ok        https://www.python.org/
(zzz_archival_docs/hg_version_control: line   75) ok        https://www.sourcetreeapp.com/
(    contributing: line  138) ok        https://www.sphinx-doc.org/en/master/
(python_packaging/pkg_structure: line  787) ok        https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.linkcheck.CheckExternalLinksBuilder
(python_packaging/pkg_structure: line  702) ok        https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
(zzz_archival_docs/hg_version_control: line  208) ok        https://www.selenic.com/mercurial/hgignore.5.html
(zzz_archival_docs/hg_version_control: line  171) ok        https://www.selenic.com/mercurial/hgrc.5.html
(     sphinx_docs: line   19) ok        https://www.latex-project.org/
(     sphinx_docs: line  260) ok        https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
(python_packaging/pkg_structure: line  702) ok        https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports
(    contributing: line  138) ok        https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
(     sphinx_docs: line   57) ok        https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
(          python: line   20) ok        https://www.tomasbeuzen.com/
(          python: line   20) ok        https://www.tomasbeuzen.com/python-programming-for-data-science/README.html
(          xios-2: line  218) ok        https://www.xmlvalidation.com/
build succeeded.

Look for any errors in the above output or in _build/linkcheck/output.txt

:command:`make linkcheck` is run monthly via a scheduled GitHub Actions workflow

Version Control Repository

The MOAD documentation source files are available as a Git repository at https://github.com/UBC-MOAD/docs.

Issue Tracker

Documentation tasks, bug reports, and enhancement ideas are recorded and managed in the issue tracker at https://github.com/UBC-MOAD/docs/issues.

License

The UBC EOAS MOAD Group Documentation is Copyright 2018 – present by by the EOAS MOAD group and The University of British Columbia.

It is licensed under a Creative Commons Attribution 4.0 International License.