diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0a14987..50d95ec 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -77,7 +77,7 @@ If you want to make a change that affects the documentation of particular facts, 1. Make the change in `doc/command_syntax_usage.rst` -2. Run `doc/generate_python_docs.py` to update `rho/fact_docs.py` +2. Run `make gen-python-docs` to update `rho/fact_docs.py` 3. Check in the new version of `rho/fact_docs.py` with your change Rho keeps fact documentation in two places - in diff --git a/Makefile b/Makefile index 86cb821..3da042c 100644 --- a/Makefile +++ b/Makefile @@ -20,7 +20,10 @@ help: all: build lint tests-coverage docs: - @cd doc; $(MAKE) gen-api; $(MAKE) html; $(MAKE) nojekyll; $(MAKE) gen-python + @cd doc; $(MAKE) gen-api; $(MAKE) html; $(MAKE) nojekyll + +gen-python-docs: + @cd doc; $(MAKE) gen-python mv doc/fact_docs.py rho build: clean diff --git a/doc/Makefile b/doc/Makefile index 36bcdd5..0d4e2c6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -25,7 +25,7 @@ nojekyll: touch $(BUILDDIR)/html/.nojekyll gen-python: - $(abspath ./generate_python_docs.py) + ./generate_python_docs.py # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).