Skip to content
This repository has been archived by the owner on Jun 29, 2022. It is now read-only.

Commit

Permalink
Separate 'gen-python-docs' from 'make docs'
Browse files Browse the repository at this point in the history
This makes sense, as we don't need to regenerate Python docs just to
generate the HTML documentation, and should also fix Travis issues.
  • Loading branch information
Noah Lavine committed Aug 9, 2017
1 parent 052b51e commit ec0de1a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion Makefile
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
Expand Up @@ -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).
Expand Down

0 comments on commit ec0de1a

Please sign in to comment.