Skip to content

Commit

Permalink
feat(build): add docs generation to Makefile
Browse files Browse the repository at this point in the history
- Add new 'docs' target in Makefile using sphinx-build
- Update dependencies in pyproject.toml:
  - Add asyncstdlib
  - Downgrade sphinx to ^7.3.7
  - Replace sphinx-autodoc-typehints with sphinx-book-theme
  • Loading branch information
bendikrb committed Sep 16, 2024
1 parent 6f22630 commit 468d098
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 27 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ format:
format-check:
$(run) ruff --check nrk_psapi

.PHONY: docs
docs:
$(run) sphinx-build docs docs/_build

.PHONY: setup
setup:
poetry install
Expand Down
145 changes: 120 additions & 25 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ isodate = "^0.6.1"
rich = "^13.8.1"
rfeed = "^1.1.1"
backoff = "^2.2.1"
asyncstdlib = "^3.12.5"

[tool.poetry.group.dev.dependencies]
aresponses = "^3.0.0"
Expand All @@ -41,8 +42,8 @@ pytest = "^8.3.3"
pytest-asyncio = "*"
pytest-cov = "^5.0.0"
ruff = "0.6.4"
sphinx = "^8.0.2"
sphinx-autodoc-typehints = "^2.4.0"
sphinx = "^7.3.7"
sphinx-book-theme = "^1.1.3"

[tool.coverage.report]
show_missing = true
Expand Down

0 comments on commit 468d098

Please sign in to comment.