-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #309 from WMD-group/docs_updates
[WIP] Documentation overhaul
- Loading branch information
Showing
108 changed files
with
108,467 additions
and
5,362 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,4 +25,4 @@ changelog: | |
- title: 🏥 Package Health | ||
labels: [pkg] | ||
- title: 🤷♂️ Other Changes | ||
labels: ["*"] | ||
labels: ["*"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ name: Publish SMACT distributions to PyPI | |
on: | ||
push: | ||
tags: | ||
- 'v*' | ||
- "v*" | ||
|
||
jobs: | ||
build-n-publish: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -224,4 +224,4 @@ $RECYCLE.BIN/ | |
|
||
*.swp | ||
|
||
*.bak | ||
*.bak |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,67 @@ | ||
repos: | ||
- repo: https://github.com/timothycrosley/isort | ||
rev: "5.12.0" | ||
hooks: | ||
- id: isort | ||
additional_dependencies: [toml] | ||
args: ["--profile", "black", "--filter-files", "--line-length=80"] | ||
- repo: https://github.com/psf/black | ||
rev: "23.1.0" | ||
hooks: | ||
- id: black-jupyter | ||
args: [--line-length=80] | ||
- repo: https://github.com/asottile/pyupgrade | ||
rev: v3.3.1 | ||
hooks: | ||
- id: pyupgrade | ||
args: [--py38-plus] | ||
- repo: https://github.com/nbQA-dev/nbQA | ||
rev: "1.8.7" | ||
hooks: | ||
- id: nbqa-pyupgrade | ||
additional_dependencies: [pyupgrade==3.3.1] | ||
args: [--py39-plus] | ||
- repo: https://github.com/astral-sh/ruff-pre-commit | ||
rev: v0.6.1 | ||
hooks: | ||
# Run the linting tool | ||
- id: ruff | ||
types_or: [python, pyi] | ||
args: [--fix] | ||
# Run the formatter | ||
- id: ruff-format | ||
types_or: [python, pyi] # TODO: Fix notebooks to remove this | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.6.0 | ||
hooks: | ||
- id: check-yaml | ||
- id: end-of-file-fixer | ||
- id: trailing-whitespace | ||
- repo: https://github.com/igorshubovych/markdownlint-cli | ||
rev: v0.41.0 | ||
hooks: | ||
- id: markdownlint | ||
# MD013: line too long | ||
# MD024: Multiple headings with the same content | ||
# MD033: no inline HTML | ||
# MD041: first line in a file should be a top-level heading | ||
# MD025: single title | ||
args: | ||
[ | ||
--ignore, | ||
"dev_docs/design_docs/*", | ||
--disable, | ||
MD013, | ||
MD024, | ||
MD025, | ||
MD033, | ||
MD041, | ||
"--", | ||
] | ||
- repo: https://github.com/pre-commit/mirrors-prettier | ||
rev: v4.0.0-alpha.8 | ||
hooks: | ||
- id: prettier | ||
args: [--write] # edit files in-place | ||
additional_dependencies: | ||
- prettier | ||
- repo: https://github.com/kynan/nbstripout | ||
rev: 0.7.1 | ||
hooks: | ||
- id: nbstripout | ||
args: [--drop-empty-cells, --keep-output] | ||
- repo: https://github.com/codespell-project/codespell | ||
rev: v2.3.0 | ||
hooks: | ||
- id: codespell | ||
stages: [commit, commit-msg] | ||
args: [--toml, pyproject.toml] | ||
additional_dependencies: | ||
- tomli | ||
- repo: https://github.com/RobertCraigie/pyright-python | ||
rev: v1.1.376 | ||
hooks: | ||
- id: pyright | ||
args: [--level, error] | ||
- repo: https://github.com/adamchainz/blacken-docs | ||
rev: 1.18.0 | ||
hooks: | ||
- id: blacken-docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
version: 2 | ||
|
||
build: | ||
os: "ubuntu-20.04" | ||
os: "ubuntu-22.04" | ||
tools: | ||
python: "3.8" | ||
python: "3.10" | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
configuration: docs/conf.py | ||
configuration: docs/conf.py | ||
|
||
# Explicitly set the version of Python and its requirements | ||
python: | ||
install: | ||
- requirements: docs/requirements.txt | ||
- requirements: docs/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.