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
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SCM syntax highlighting & preventing 3-way merges
pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff
14 changes: 2 additions & 12 deletions .github/workflows/sphinx-linkcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,5 @@ jobs:
sphinx-linkcheck:
permissions:
contents: read
strategy:
fail-fast: false
matrix:
# Need to specify Python version here because we use test env which gets its
# Python version via matrix
python-version: [ '3.14' ]
uses: UBC-MOAD/gha-workflows/.github/workflows/sphinx-linkcheck.yaml@main
with:
python-version: ${{ matrix.python-version }}
conda-env-file: environment.yaml
conda-env-name: moad-docs
docs-dir: .

uses: UBC-MOAD/gha-workflows/.github/workflows/pixi-sphinx-linkcheck.yaml@main
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
### Sphinx documentation
_build/

# pixi environments
.pixi/*
!.pixi/config.toml


### Vim template
# Swap
Expand Down
1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ repos:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-toml
- id: check-added-large-files
20 changes: 14 additions & 6 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,23 @@ version: 2
build:
os: ubuntu-24.04
tools:
python: "mambaforge-23.11"
python: "latest"

conda:
environment: environment.yaml
jobs:
create_environment:
- asdf plugin add pixi
- asdf install pixi latest
- asdf global pixi latest
install:
- pixi install
build:
html:
- pixi run sphinx-build -T -b html ./ $READTHEDOCS_OUTPUT/html

sphinx:
builder: html
configuration: conf.py
fail_on_warning: false
configuration: conf.py
fail_on_warning: false


# Only build HTML and JSON formats
formats: []
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ UBC EOAS MOAD Group Documentation

[![Creative Commons Attribution International 4.0 License](https://img.shields.io/badge/license-CC--BY-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![Git on GitHub](https://img.shields.io/badge/version%20control-git-blue.svg?logo=github)](https://github.com/UBC-MOAD/docs)
[![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)
[![Documentation Status](https://app.readthedocs.org/projects/ubc-moad-docs/badge/?version=latest)](https://ubc-moad-docs.readthedocs.io/en/latest/)
[![sphinx-linkcheck](https://github.com/UBC-MOAD/docs/workflows/sphinx-linkcheck/badge.svg)](https://github.com/UBC-MOAD/docs/actions?query=workflow:sphinx-linkcheck)
[![Issue Tracker](https://img.shields.io/github/issues/UBC-MOAD/docs?logo=github)](https://github.com/UBC-MOAD/docs/issues)
Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', '.pixi', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down
495 changes: 242 additions & 253 deletions contributing.rst

Large diffs are not rendered by default.

36 changes: 0 additions & 36 deletions environment.yaml

This file was deleted.

3,063 changes: 3,063 additions & 0 deletions pixi.lock

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions pixi.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[workspace]
authors = ["Doug Latornell <dlatornell@eoas.ubc.ca>"]
channels = ["conda-forge"]
name = "moad-docs"
platforms = ["linux-64", "osx-64", "osx-arm64", "win-64"]
repository = "https://github.com/UBC-MOAD/docs"
documentation = "https://ubc-moad-docs.readthedocs.io/en/latest/"

[tasks]
docs = "make clean html"
linkcheck = "make clean linkcheck"
update-reqs = "python -m pip list --format=freeze >> requirements.txt"

[dependencies]
python = "3.14.*"
# For repo QA
pip = "*"
pre-commit = "*"
# For building the docs
nbsphinx = "==0.9.5"
sphinx = "==8.1.3"
sphinx-notfound-page = "==1.0.4"
sphinx-rtd-theme = "==3.0.0"

[pypi-dependencies]
# For build on readthedocs
commonmark = ">=0.9.1, <0.10"
recommonmark = ">=0.7.1, <0.8"
readthedocs-sphinx-ext = ">=2.2.5, <3"
61 changes: 39 additions & 22 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,70 +1,87 @@
# Python packages and versions used in recent docs development environment
# Python packages and versions used most recently in docs development environment
#
# Create/update this file with:
# (moad-docs)$ python -m pip list --format=freeze >> requirements.txt
# This file is retained so that we will continue to get security update notifications
# and PRs from dependabot. It will be dropped when dependabot adds support for
# the `pixi.lock` file.
#
# Update this file with:
# pixi run update-reqs

alabaster==1.0.0
attrs==25.4.0
babel==2.17.0
beautifulsoup4==4.14.2
beautifulsoup4==4.14.3
bleach==6.3.0
certifi==2025.11.12
Brotli==1.2.0
certifi==2026.1.4
cffi==2.0.0
cfgv==3.3.1
cfgv==3.5.0
charset-normalizer==3.4.4
colorama==0.4.6
commonmark==0.9.1
defusedxml==0.7.1
distlib==0.4.0
docutils==0.21.2
fastjsonschema==2.21.2
filelock==3.20.3
identify==2.6.15
h2==4.3.0
hpack==4.1.0
hyperframe==6.1.0
identify==2.6.16
idna==3.11
imagesize==1.4.1
importlib_metadata==8.7.0
Jinja2==3.1.6
jsonschema==4.25.1
jsonschema==4.26.0
jsonschema-specifications==2025.9.1
jupyter_client==8.6.3
jupyter_client==8.8.0
jupyter_core==5.9.1
jupyterlab_pygments==0.3.0
MarkupSafe==3.0.3
mistune==3.1.4
nbclient==0.10.2
mistune==3.2.0
nbclient==0.10.4
nbconvert==7.16.6
nbformat==5.10.4
nbsphinx==0.9.5
nodeenv==1.9.1
nodeenv==1.10.0
packaging==25.0
pandocfilters==1.5.1
pandocfilters==1.5.0
pip==25.3
platformdirs==4.5.0
pre_commit==4.4.0
platformdirs==4.5.1
pre_commit==4.5.1
pycparser==2.22
Pygments==2.19.2
PySocks==1.7.1
python-dateutil==2.9.0.post0
pytz==2025.2
PyYAML==6.0.3
pyzmq==27.1.0
readthedocs-sphinx-ext==2.2.5
recommonmark==0.7.1
referencing==0.37.0
requests==2.32.5
rpds-py==0.29.0
setuptools==80.9.0
rpds-py==0.30.0
setuptools==80.10.1
six==1.17.0
snowballstemmer==3.0.1
soupsieve==2.8
soupsieve==2.8.3
Sphinx==8.1.3
sphinx-notfound-page==1.0.4
sphinx-rtd-theme==3.0.0
sphinx_rtd_theme==3.0.0
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
tinycss2==1.4.0
tornado==6.5.2
sphinxcontrib-serializinghtml==1.1.10
tinycss2==1.5.1
tomli==2.4.0
tornado==6.5.3
traitlets==5.14.3
typing_extensions==4.15.0
ukkonen==1.0.1
urllib3==2.6.3
virtualenv==20.36.1
webencodings==0.5.1
zipp==3.23.0