Skip to content

Commit 705cad7

Browse files
authored
Merge pull request #844 from dschaller/make-docs
add root make target for creating html version of docs
2 parents 8eb23ed + a4c812f commit 705cad7

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

Makefile

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.PHONY: help
2+
help:
3+
@echo "Please use \`make <target>' where <target> is one of"
4+
@grep -E '^\.PHONY: [a-zA-Z_-]+ .*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = "(: |##)"}; {printf "\033[36m%-30s\033[0m %s\n", $$2, $$3}'
5+
6+
.PHONY: docs ## Generate docs
7+
docs:
8+
@cd docs &&\
9+
pip install -r requirements.txt &&\
10+
make html &&\
11+
cd -

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,8 @@ Tox can only use whatever versions of python are installed on your system. When
112112

113113
The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme.
114114

115-
The documentation dependencies are installed by running:
115+
An HTML version of the documentation is produced by running:
116116

117117
```sh
118-
cd docs
119-
pip install -r requirements.txt
120-
```
121-
122-
Then to produce a HTML version of the documentation:
123-
124-
```sh
125-
make html
118+
make docs
126119
```

0 commit comments

Comments
 (0)