Skip to content

Commit

Permalink
Update docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
jodal committed Jun 4, 2023
1 parent b0c5611 commit 675026b
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 17 deletions.
18 changes: 9 additions & 9 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
version: 2

build:
image: latest

python:
version: 3.7
install:
- requirements: docs/requirements.txt
- method: pip
path: .
os: "ubuntu-22.04"
tools:
python: "3.11"
jobs:
post_install:
- pip install poetry
- poetry config virtualenvs.create false
- poetry install --all-extras --only=main,docs

sphinx:
builder: htmldir
configuration: docs/conf.py
builder: dirhtml

formats: all
8 changes: 6 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@

autodoc_member_order = "bysource"

extlinks = {"issue": ("https://github.com/jodal/pykka/issues/%s", "#")}
extlinks = {
"issue": ("https://github.com/jodal/pykka/issues/%s", "#%s"),
}

intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
}
3 changes: 0 additions & 3 deletions docs/requirements.txt

This file was deleted.

5 changes: 5 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@ pytest-cov = "^3.0.0"
pytest-mock = "^3.6.1"
tox = "^3.23.1"

[tool.poetry.group.docs.dependencies]
sphinx = "^6.2.1"
sphinx_rtd_theme = "^1.2.1"
toml = "^0.10.2"

[tool.black]
target-version = ["py37", "py38", "py39", "py310", "py311"]

Expand Down
5 changes: 2 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,9 @@ commands =
{posargs}

[testenv:docs]
changedir = docs
commands =
python -m pip install -r requirements.txt
python -m sphinx -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
poetry install --all-extras --only=main,docs
python -m sphinx -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html

[testenv:flake8]
commands =
Expand Down

0 comments on commit 675026b

Please sign in to comment.