Skip to content

Latest commit

 

History

History
472 lines (394 loc) · 29.7 KB

File metadata and controls

472 lines (394 loc) · 29.7 KB

Contributing to These Docs

Licensed under the Creative Commons Attribution 4.0 International License Git on GitHub Documentation Status Sphinx linkcheck Issue Tracker Python Version

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
  • build the docs with your changes locally, and preview them in Firefox or your favourite browser instead of having to push commits to GitHub to trigger a build on readthedocs.org,

Getting the Repo

Git on GitHub

Clone the MOAD documentation repository from GitHub with:

$ git clone git@github.com: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

Pixi

This repository uses Pixi for package and environment management. If you don't already have Pixi installed, please follow its installation instructions to do so.

Most commands are executed using :command:`pixi run` in the :file:`docs/` directory (or a sub-directory). Dependencies will be downloaded and linked in to the working environment when you use :command:`pixi run` for the first time.

To get detailed information about the environment, the packages installed in it, Pixi tasks that are defined, etc., use :command:`pixi info`.

Building and Previewing the Documentation

Documentation Status

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`. To do a clean build of the documentation use:

$ cd docs/
$ pixi run docs

The output looks something like:

 ✨ Pixi task (docs): make clean html
 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/documentation_options.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/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%] VSCodeSelectJupyterKernel.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:

$ 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

Sphinx linkcheck

Sphinx also provides a link checker utility which can be run to find broken or redirected links in the docs. Run the link checker with:

$ cd docs/
$ pixi run linkcheck

The output looks something like:

 ✨ Pixi task (linkcheck): make clean linkcheck
 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  210) -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   15) ok        http://ariane.lagrangian.free.fr/whatsariane.html
 (          ariane: line   24) ok        http://ariane.lagrangian.free.fr/ariane_namelist_2.x.x_oct08.pdf
 (          ariane: line   37) ok        http://ariane.lagrangian.free.fr/download.php
 (          ariane: line   23) ok        http://ariane.lagrangian.free.fr/ariane_install_2.x.x_sep08.pdf
 (python_packaging/pkg_structure: line  181) ok        https://about.readthedocs.com/?ref=readthedocs.org
 (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/
 (    contributing: line   21) ok        https://app.readthedocs.org/projects/ubc-moad-docs/badge/?version=latest
 (          globus: line   27) ok        https://app.globus.org/file-manager
 (git_version_control: line   60) ok        https://brew.sh/
 (python_packaging/pkg_structure: line   39) ok        https://bskinn.github.io/My-How-Why-Pyproject-Src/
 (python_packaging/pkg_structure: line  483) ok        https://calver.org/
 (python_packaging/pkg_structure: line  296) ok        https://click.palletsprojects.com/en/latest/
 (alliance-computing: line   85) redirect  https://ccdb.alliancecan.ca/me/access_systems - with Found to https://ccdb.alliancecan.ca/security/login
 (    contributing: line   46) ok        https://app.readthedocs.org/projects/ubc-moad-docs/builds/
 (          xios-2: line  405) ok        https://cfconventions.org/Data/cf-standard-names/29/build/cf-standard-name-table.html
 (alliance-computing: line   55) ok        https://ccdb.alliancecan.ca/account_application
 (   analysis_repo: line  156) ok        https://cookiecutter.readthedocs.io/en/latest/
 (python_packaging/pkg_structure: line  164) ok        https://coverage.readthedocs.io/en/latest/
 (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  745) ok        https://doc.pytest.org/en/latest/explanation/goodpractices.html#tests-outside-application-code
 (conda_pkg_env_mgr: line   39) ok        https://conda-forge.org/
 (          vscode: line   15) ok        https://code.visualstudio.com/
 (         jupyter: line  442) ok        https://docs.alliancecan.ca/wiki/Anaconda/en
 (alliance-computing: line   63) ok        https://docs.alliancecan.ca/wiki/Apply_for_a_CCDB_account
 (alliance-computing: line  120) ok        https://docs.alliancecan.ca/wiki/SSH_Keys#Using_CCDB
 (alliance-computing: line   72) ok        https://docs.alliancecan.ca/wiki/Multifactor_authentication
 (alliance-computing: line   69) ok        https://docs.alliancecan.ca/wiki/Getting_started
 (         jupyter: line  482) ok        https://docs.alliancecan.ca/wiki/Python#Creating_and_using_a_virtual_environment
 (python_packaging/pkg_structure: line   60) ok        https://docs.conda.io/projects/conda/en/latest/
 (python_packaging/pkg_structure: line  773) ok        https://docs.github.com/en/actions
 (    contributing: line   77) ok        https://docs.github.com/en/authentication/connecting-to-github-with-ssh
 (conda_pkg_env_mgr: line  186) ok        https://docs.conda.io/projects/conda/en/latest/user-guide/configuration/use-condarc.html
 (python_packaging/pkg_structure: line  778) ok        https://docs.github.com/en/code-security/concepts/code-scanning/codeql/about-code-scanning-with-codeql
 (conda_pkg_env_mgr: line   15) ok        https://docs.conda.io/en/latest/
 (      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
 (git_version_control: line   22) ok        https://docs.github.com/en/get-started
 (oceanparcels/index: line   23) ok        https://docs.oceanparcels.org/en/latest/reference/predefined_kernels.html
 (    contributing: line   13) ok        https://docs.python.org/3/
 (python_packaging/pkg_structure: line  376) ok        https://docs.readthedocs.com/platform/stable/config-file/v2.html
 (     bash_config: line   43) ok        https://douglatornell.github.io/2013-09-26-ubc/lessons/ref/shell.html
 (          xios-2: line  160) ok        https://en.wikipedia.org/wiki/XML
 (python_packaging/pkg_structure: line  761) ok        https://docs.github.com/en/code-security/how-tos/secure-your-supply-chain/secure-your-dependencies/configuring-dependabot-security-updates
 (python_packaging/pkg_structure: line  279) ok        https://docs.openstack.org/cliff/latest/
 (          vscode: line  157) ok        https://fortls.fortran-lang.org/index.html
 (    contributing: line  434) ok        https://git-scm.com/
 (git_version_control: line   22) ok        https://git-scm.com/book/en/v2
 (git_version_control: line   22) ok        https://git-scm.com/doc
 (git_version_control: line  127) ok        https://git-scm.com/docs/git-config
 (git_version_control: line   56) ok        https://git-scm.com/downloads
 (git_version_control: line  213) ok        https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository
 (git_version_control: line  151) ok        https://git-scm.com/book/en/v2/Appendix-C%3A-Git-Commands-Setup-and-Config#ch_core_editor
 ( getting_started: line   55) ok        https://github.com/
 (          xios-2: line  297) ok        https://forge.ipsl.fr/ioserver/raw-attachment/wiki/WikiStart/XIOS_user_guide.pdf
 (       vcs_repos: line   19) ok        https://github.com/MIDOSS/
 (          xios-2: line   15) ok        https://forge.ipsl.fr/ioserver/wiki
 (     sphinx_docs: line   36) ok        https://github.com/MIDOSS/docs
 (oceanparcels/index: line   21) ok        https://github.com/Parcels-code/Parcels/discussions
 (       vcs_repos: line   18) ok        https://github.com/SalishSeaCast/
 (   analysis_repo: line   62) ok        https://github.com/SalishSeaCast
 (          xios-2: line  417) ok        https://github.com/SalishSeaCast/SS-run-sets/tree/main/v201702
 (          xios-2: line  216) ok        https://github.com/SalishSeaCast/SS-run-sets
 (          xios-2: line   41) ok        https://github.com/SalishSeaCast/XIOS-ARCH
 (python_packaging/pkg_structure: line   24) ok        https://github.com/SalishSeaCast/NEMO-Cmd
 (   analysis_repo: line   33) ok        https://github.com/SalishSeaCast/analysis-susan
 (github_notebooks_readme: line    7) ok        https://github.com/SalishSeaCast/analysis-ben/tree/master/notebooks
 (     sphinx_docs: line   36) ok        https://github.com/SalishSeaCast/docs
 ( getting_started: line   55) ok        https://github.com/UBC-MOAD
 (       vcs_repos: line   17) ok        https://github.com/UBC-MOAD/
 (   analysis_repo: line  316) ok        https://github.com/SalishSeaCast/tools
 (     sphinx_docs: line   79) ok        https://github.com/UBC-MOAD/PythonNotes/blob/main/sphinx-docs/SphinxDocsTutorial.ipynb
 (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
 (python_packaging/pkg_structure: line  296) ok        https://github.com/UBC-MOAD/Reshapr
 (   analysis_repo: line   51) ok        https://github.com/UBC-MOAD/cookiecutter-analysis-repo
 (    contributing: line   24) ok        https://github.com/UBC-MOAD/docs/workflows/sphinx-linkcheck/badge.svg
 (    contributing: line  460) ok        https://github.com/UBC-MOAD/docs/blob/main/CONTRIBUTORS.rst
 (    contributing: line   13) ok        https://github.com/UBC-MOAD/docs/issues
 (python_packaging/pkg_structure: line  799) ok        https://github.com/UBC-MOAD/gha-workflows
 (     sphinx_docs: line   36) ok        https://github.com/UBC-MOAD/moad_tools
 (python_packaging/pkg_structure: line  419) ok        https://github.com/github/gitignore
 (conda_pkg_env_mgr: line   39) ok        https://github.com/conda-forge/miniforge
 (python_packaging/pkg_structure: line   35) ok        https://hatch.pypa.io/latest/
 (python_packaging/pkg_structure: line  202) ok        https://hatch.pypa.io/latest/config/metadata/
 (    contributing: line   13) ok        https://github.com/UBC-MOAD/docs/actions?query=workflow:sphinx-linkcheck
 (git_version_control: line  215) ok        https://github.com/github/gitignore/blob/main/Python.gitignore
 (         jupyter: line  511) ok        https://github.com/h5netcdf/h5netcdf
 (    contributing: line   15) ok        https://img.shields.io/badge/license-CC--BY-lightgrey.svg
 (    contributing: line   30) ok        https://img.shields.io/badge/python-3.14-blue.svg
 (    contributing: line   18) ok        https://img.shields.io/badge/version%20control-git-blue.svg?logo=github
 (    contributing: line   89) ok        https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json
 (python_packaging/pkg_structure: line   37) ok        https://hynek.me/articles/testing-packaging/
 (         jupyter: line   24) ok        https://jupyter-notebook.readthedocs.io/en/stable/
 (github_notebooks_readme: line   12) ok        https://jupyter.org/
 (    contributing: line   27) ok        https://img.shields.io/github/issues/UBC-MOAD/docs?logo=github
 (      ssh_access: line   71) ok        https://learn.microsoft.com/en-ca/windows-server/administration/openssh/openssh_install_firstuse
 (          vscode: line  123) ok        https://marketplace.visualstudio.com/items?itemName=Digoro.Clipboard
 (zzz_archival_docs/hg_version_control: line   27) ok        https://hgbook.red-bean.com/read/how-did-we-get-here.html
 (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/
 (          vscode: line  129) ok        https://marketplace.visualstudio.com/items?itemName=fortran-lang.linter-gfortran
 (          vscode: line  111) ok        https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
 (          vscode: line  136) ok        https://marketplace.visualstudio.com/items?itemName=mechatroner.rainbow-csv
 (          vscode: line   96) ok        https://marketplace.visualstudio.com/items?itemName=ms-toolsai.jupyter-renderers
 (          vscode: line  148) ok        https://marketplace.visualstudio.com/items?itemName=tomoki1207.pdf
 (          vscode: line   42) ok        https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh
 (          vscode: line  117) ok        https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
 (          vscode: line  142) ok        https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst
 (         jupyter: line  120) ok        https://marketplace.visualstudio.com/items?itemName=ms-python.python
 (github_notebooks_readme: line   12) ok        https://nbviewer.org/
 (          ariane: line  560) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/Ariane_Tracers.ipynb
 (oceanparcels/index: line   24) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/OceanParcelsRecipes.ipynb
 (          xios-2: line   26) ok        https://nemo-cmd.readthedocs.io/en/latest/index.html#nemo-commandprocessor
 (          xios-2: line  236) ok        https://nemo-cmd.readthedocs.io/en/latest/run_description_file/3.6_yaml_file.html#output-section
 (          python: line   20) ok        https://numpy.org/
 (          ariane: line  195) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/ParticleTracking.ipynb
 (python_packaging/pkg_structure: line   36) ok        https://packaging.python.org/en/latest/
 (python_packaging/pkg_structure: line   67) ok        https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site
 (oceanparcels/index: line   22) ok        https://os.copernicus.org/articles/17/1067/2021/
 (          python: line   20) ok        https://pandas.pydata.org/
 (oceanparcels/index: line   19) ok        https://parcels-code.org/
 (oceanparcels/index: line   13) ok        https://parcels-code.org/index.html
 (python_packaging/pkg_structure: line  483) ok        https://peps.python.org/pep-0440/
 (python_packaging/pkg_structure: line   53) ok        https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
 (    contributing: line   87) ok        https://pixi.prefix.dev/latest/
 (conda_pkg_env_mgr: line   30) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/pkgs-envs/PythonPkgsEnvsSlides-2023.ipynb
 (    contributing: line   93) ok        https://pixi.prefix.dev/latest/installation/
 (         jupyter: line  499) ok        https://pypi.org/
 (          python: line   51) ok        https://realpython.com/
 (     sphinx_docs: line  183) ok        https://rhodesmill.org/brandon/2012/one-sentence-per-line/
 (python_packaging/pkg_structure: line  183) ok        https://pre-commit.com/
 (alliance-computing: line  248) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/nibi.html#compilenemo-3-6-nibi
 (alliance-computing: line  242) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/nibi.html#installcommandprocessorpackages
 (alliance-computing: line  238) ok        https://salishsea-meopar-docs.readthedocs.io/en/latest/code-notes/salishsea-nemo/quickstart/nibi.html#createworkspaceandclonerepositories
 (   analysis_repo: line  320) ok        https://salishsea-meopar-tools.readthedocs.io/en/latest/SalishSeaTools/index.html
 (   analysis_repo: line  320) ok        https://salishsea-meopar-tools.readthedocs.io/en/latest/visualisation/visualization_workflows_xarray.html
 (alliance-computing: line  242) ok        https://salishseacmd.readthedocs.io/en/latest/index.html#salishseacmdprocessor
 (          xios-2: line  236) ok        https://salishseacmd.readthedocs.io/en/latest/run_description_file/3.6_yaml_file.html#output-section
 (oceanparcels/index: line   20) ok        https://salishseacast.slack.com/?redir=%2Farchives%2FC02ETTPHFPX
 (git_version_control: line  151) ok        https://salishseacast.slack.com/?redir=%2Farchives%2FCFR6VU70S
 (     sphinx_docs: line   78) ok        https://nbviewer.org/github/UBC-MOAD/PythonNotes/blob/main/sphinx-docs/SphinxDocsTutorial.ipynb
 (python_packaging/pkg_structure: line   40) ok        https://snarky.ca/clarifying-pep-518/
 (     bash_config: line   43) ok        https://software-carpentry.org/
 (zzz_archival_docs/hg_version_control: line   48) ok        https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/
 (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
 (     sphinx_docs: line   88) ok        https://ubc-moad-tools.readthedocs.io/en/latest/pkg_development.html#moad-toolspackageddevelopment
 (zzz_archival_docs/hg_version_control: line   75) ok        https://tortoisehg.bitbucket.io/
 (zzz_archival_docs/hg_version_control: line   27) ok        https://wiki.mercurial-scm.org/BeginnersGuides
 (zzz_archival_docs/hg_version_control: line  248) ok        https://wiki.mercurial-scm.org/RebaseExtension#Scenario_A
 (zzz_archival_docs/hg_version_control: line  248) ok        https://wiki.mercurial-scm.org/RebaseExtension
 (zzz_archival_docs/hg_version_control: line  262) ok        https://wiki.mercurial-scm.org/RebaseExtension#Scenarios
 (conda_pkg_env_mgr: line   15) ok        https://www.anaconda.com/download
 (          ariane: line  787) ok        https://nbviewer.org/github/SalishSeaCast/analysis/blob/master/Idalia/Ariane_TimeRes.ipynb
 (python_packaging/pkg_structure: line  355) ok        https://www.apache.org/licenses/
 (    CONTRIBUTORS: line    7) ok        https://www.eoas.ubc.ca/~sallen/
 (      ssh_access: line   31) ok        https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server
 (          globus: line   15) ok        https://www.globus.org/data-transfer
 (     sphinx_docs: line   19) ok        https://www.mathjax.org/
 (alliance-computing: line   15) ok        https://www.alliancecan.ca/en
 (          python: line   15) ok        https://www.python.org/
 (zzz_archival_docs/hg_version_control: line   63) ok        https://www.mercurial-scm.org/install
 (zzz_archival_docs/hg_version_control: line   21) ok        https://www.mercurial-scm.org/
 (zzz_archival_docs/hg_version_control: line   75) ok        https://www.sourcetreeapp.com/
 (    contributing: line  121) ok        https://www.sphinx-doc.org/en/master/
 (     sphinx_docs: line   19) ok        https://www.latex-project.org/
 (python_packaging/pkg_structure: line  702) ok        https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
 (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#confval-autodoc_mock_imports
 (     sphinx_docs: line  260) ok        https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
 (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
 (    contributing: line  121) 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-programming-for-data-science/README.html
 (          python: line   20) ok        https://www.tomasbeuzen.com/
 (          xios-2: line  199) 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

Git on GitHub

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

Issue Tracker

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

Licensed under the Creative Commons Attribution 4.0 International 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.