Skip to content

Commit

Permalink
docs: fix docu generation
Browse files Browse the repository at this point in the history
  • Loading branch information
15r10nk committed Apr 10, 2024
1 parent 7625515 commit 5e97605
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/test_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: test docs
on:
pull_request:
push:
branches: [main]

jobs:
build:
name: build docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- run: pip install nox==2023.4.22
- run: pip install poetry nox-poetry
- run: nox --session mkdocs -- build
8 changes: 4 additions & 4 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,12 @@ def test(session):


@session(python="python3.10")
def docs(session):
def docs_serve(session):
session.install("mkdocs", "mkdocs-material[imaging]", "mkdocstrings[python]")
session.run("mkdocs", "build", *session.posargs)
session.run("mkdocs", "serve", *session.posargs)


@session(python="python3.10")
def docs_serve(session):
def mkdocs(session):
session.install("mkdocs", "mkdocs-material[imaging]", "mkdocstrings[python]")
session.run("mkdocs", "serve", *session.posargs)
session.run("mkdocs", *session.posargs)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ time-machine = ">=2.10.0"

[tool.poetry.group.doc.dependencies]
mkdocs = ">=1.4.2"
mkdocs-material = {extras = ["imaging"], version = ">=8.5.10"}
mkdocs-material = {extras = ["imaging"], version = ">=9.5.17"}
mkdocstrings = {extras = ["python-legacy"], version = ">=0.19.0"}

[tool.poetry.plugins.pytest11]
Expand Down

0 comments on commit 5e97605

Please sign in to comment.