Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: remove .html from page URLs #50

Merged
merged 4 commits into from
Jan 20, 2024
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: 1 addition & 1 deletion .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
tasks:
- init: pyenv local 3.8
- init: pyenv local 3.9
- init: pip install -e .[dev]

github:
Expand Down
37 changes: 18 additions & 19 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,25 @@ repos:
hooks:
- id: black

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier

- repo: https://github.com/ComPWA/mirrors-taplo
rev: v0.8.1
hooks:
- id: taplo

- repo: https://github.com/pappasam/toml-sort
rev: v0.23.1
hooks:
- id: toml-sort
args: [--in-place]
exclude: (?x)^(labels.*\.toml)$

- repo: https://github.com/ComPWA/policy
rev: 0.2.0
rev: 0.2.3
hooks:
- id: check-dev-files
args:
Expand Down Expand Up @@ -66,11 +83,6 @@ repos:
.*\.py
)$

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier

- repo: https://github.com/ComPWA/mirrors-pyright
rev: v1.1.345
hooks:
Expand All @@ -82,16 +94,3 @@ repos:
- id: ruff
args:
- --fix

- repo: https://github.com/ComPWA/mirrors-taplo
rev: v0.8.1
hooks:
- id: taplo

- repo: https://github.com/pappasam/toml-sort
rev: v0.23.1
hooks:
- id: toml-sort
args:
- --in-place
exclude: (?x)^(labels.*\.toml)$
4 changes: 2 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2

sphinx:
builder: html
builder: dirhtml
configuration: docs/conf.py
fail_on_warning: true

Expand All @@ -11,7 +11,7 @@ formats:
build:
os: ubuntu-22.04
tools:
python: "3.8"
python: "3.9"
jobs:
post_install:
- pip install -e .[doc]
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/redeboer/bossdoc)
[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/redeboer/bossdoc)

See instructions [here](https://bes3.readthedocs.io/contribute.html).
See instructions [here](https://bes3.readthedocs.io/contribute).
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: bossdoc
channels:
- defaults
dependencies:
- python==3.8.*
- python==3.9.*
- pip
- pip:
- -e .[dev]
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ format = [
]
lint = [
"ruff",
"sphinx-api-relink",
]
sty = [
"Sphinx",
Expand Down
5 changes: 3 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ commands =
--color \
--keep-going \
-TW \
-b html \
-b dirhtml \
docs/ docs/_build/html

[testenv:doclive]
Expand Down Expand Up @@ -58,6 +58,7 @@ commands =
--re-ignore docs/api/.* \
--watch docs \
--watch src \
-b dirhtml \
docs/ docs/_build/html

[testenv:docnb]
Expand All @@ -76,7 +77,7 @@ commands =
--color \
--keep-going \
-TW \
-b html \
-b dirhtml \
docs/ docs/_build/html

[testenv:linkcheck]
Expand Down
Loading