From 4aad369c9728061c97b3de792286e743ee884b09 Mon Sep 17 00:00:00 2001 From: growupboron Date: Fri, 11 Sep 2020 17:18:57 +0530 Subject: Simplified doc-site generation Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs Signed-off-by: growupboron Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236 Reviewed-by: Jan-Simon Moeller Tested-by: Jan-Simon Moeller --- theme/Makefile | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 theme/Makefile (limited to 'theme/Makefile') diff --git a/theme/Makefile b/theme/Makefile new file mode 100644 index 0000000..1480ec0 --- /dev/null +++ b/theme/Makefile @@ -0,0 +1,26 @@ +VERSION=`python setup.py --version` + +default: + @echo "Specify one of: serve, publish_docs, publish_package" + +serve: + env/bin/mkdocs serve -a localhost:8000 + +test: + env MKDOCS_BINARY=env/bin/mkdocs npm -C tests test + +test-debug: + env MKDOCS_BINARY=env/bin/mkdocs npm -C tests run test-debug + +publish_docs: + env/bin/mkdocs gh-deploy + +publish_package: + @echo Build python distribution + python setup.py sdist bdist_wheel + @echo "Publish to PyPI at https://pypi.python.org/pypi/mkdocs-windmill" + @echo "Version in setup.py is $(VERSION)" + @echo "Git tag is `git describe --tags`" + @echo "Run this manually: python3 -m twine upload dist/mkdocs-windmill-$(VERSION).tar.gz dist/mkdocs_windmill-$(VERSION)-py2-none-any.whl" + +.PHONY: serve publish_docs publish_package -- cgit 1.2.3-korg