Skip to content

Commit

Permalink
Sandbox: Add poe task targets for documentation management
Browse files Browse the repository at this point in the history
- `poe docs-linkcheck`
- `poe docs-html`
  • Loading branch information
amotl committed Dec 19, 2022
1 parent c5952e2 commit f394e7c
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 13 deletions.
13 changes: 0 additions & 13 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,6 @@ test-coverage: install-tests
release: bumpversion push build upload


# -------------
# Documentation
# -------------

# Build the documentation
docs-html: install-doctools
touch doc/index.rst
export SPHINXBUILD="`pwd`/$(sphinx)"; cd doc; make html


# ===============
# Utility targets
# ===============
Expand All @@ -84,9 +74,6 @@ build:
upload:
$(twine) upload --skip-existing dist/*{.tar.gz,.whl}

install-doctools: setup-virtualenv
@$(pip) install --quiet --requirement requirements-docs.txt --upgrade

install-releasetools: setup-virtualenv
@$(pip) install --quiet --requirement requirements-release.txt --upgrade

Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ extend-exclude = [

[tool.poe.tasks]
build = {cmd="python -m build"}
docs-html = {cmd="sh -c 'cd doc && make html'"}
docs-linkcheck = {cmd="sh -c 'cd doc && make linkcheck'"}
format = [
{cmd="black ."},
{cmd="isort ."},
Expand Down

0 comments on commit f394e7c

Please sign in to comment.