Fix small bug in mkdocs (#178)

* fix bug * add make docs-serve * add make docs-setup
drivendataorg · Oct 20, 2021 · 3901746 · 3901746
1 parent cce6a2f
commit 3901746
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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://raw.githubusercontent.com/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
@@ -68,7 +68,7 @@ plugins:
             group_by_category: true
             show_category_heading: true
       watch:
-        - cloudpathlib
+        - ../cloudpathlib
 
 extra:
   version: