Skip to content

Commit

Permalink
setup: update documentation related commands in Makefile (#252)
Browse files Browse the repository at this point in the history
  • Loading branch information
ixje committed Mar 7, 2023
1 parent 968140c commit d7e2c02
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: black build clean clean-test clean-pyc clean-build docs help test coverage version-major version-minor version-patch
.PHONY: black build clean clean-test clean-pyc clean-build clean-docs docs docs-deploy help test coverage version-major version-minor version-patch
.DEFAULT_GOAL := help
define BROWSER_PYSCRIPT
import os, webbrowser, sys
Expand Down Expand Up @@ -26,7 +26,7 @@ BROWSER := python3 -c "$$BROWSER_PYSCRIPT"
help:
@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)

clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
clean: clean-build clean-pyc clean-test clean-docs ## remove all build, test, coverage and Python artifacts


clean-build: ## remove build artifacts
Expand All @@ -36,6 +36,9 @@ clean-build: ## remove build artifacts
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -f {} +

clean-docs: ## clean the /docs/
rm -rf docs/site/

clean-pyc: ## remove Python file artifacts
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
Expand All @@ -55,13 +58,13 @@ coverage: ## check code coverage quickly with the default Python
coverage html
$(BROWSER) htmlcov/index.html

clean-docs: ## clean the /docs/
cd docs && $(MAKE) clean

docs: ## generate Sphinx HTML documentation, including API docs
rm -rf docs/build/
sphinx-build -b html docs/source/ docs/build/
$(BROWSER) docs/build/index.html
rm -rf docs/site/
mkdocs build -f docs/mkdocs.yml
$(BROWSER) docs/site/index.html

docs-deploy: ## manually deploy the docs to github pages
aws s3 sync ./docs/site s3://docs-coz/neo3/mamba --acl public-read

type: ## perform static type checking using mypy
mypy neo3/
Expand All @@ -79,4 +82,4 @@ version-minor: ## bump the minor version prior to release, auto commits and tag
bumpversion minor

version-patch: ## bump the patch version prior to release, auto commits and tag
bumpversion patch
bumpversion patch

0 comments on commit d7e2c02

Please sign in to comment.