Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 0c922a9

Browse files
committedAug 14, 2016
Updated docs about building docs.
1 parent 9bed3f2 commit 0c922a9

File tree

3 files changed

+34
-5
lines changed

3 files changed

+34
-5
lines changed
 

‎Makefile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,13 @@ test:
3434

3535
.PHONY: docs
3636
docs:
37+
pdoc --html --html-dir docs --overwrite --all-submodules --external-links wepay/signer
3738

3839
.PHONY: pushdocs
3940
pushdocs: docs
4041
rm -Rf /tmp/gh-pages
41-
git clone git@github.devops.wepay-inc.com:devtools/datacenter.git --branch gh-pages --single-branch /tmp/gh-pages
42-
cp -Rf ./docs/* /tmp/gh-pages/
42+
git clone git@github.com:wepay/signer-python.git --branch gh-pages --single-branch /tmp/gh-pages
43+
cp -Rf ./docs/signer/* /tmp/gh-pages/
4344
cd /tmp/gh-pages/ && git add . && git commit -a -m "Automated commit on $$(date)" && git push origin gh-pages
4445

4546
#-------------------------------------------------------------------------------
@@ -62,7 +63,7 @@ tag:
6263
@ if [ $$(git status -s -uall | wc -l) != 0 ]; then echo 'ERROR: Git workspace must be clean.'; exit 1; fi;
6364

6465
@echo "This release will be tagged as: $$(cat ./VERSION)"
65-
@echo "This version should match your gem. If it doesn't, re-run 'make gem'."
66+
@echo "This version should match your package. If it doesn't, re-run 'make buildpip'."
6667
@echo "---------------------------------------------------------------------"
6768
@read -p "Press any key to continue, or press Control+C to cancel. " x;
6869

‎README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,20 @@ We use [tox] to handle local testing across multiple versions of Python. We inst
132132

133133
## API Reference
134134

135-
TBD.
135+
### Building local docs
136+
137+
```bash
138+
make docs
139+
open docs/signer/index.html
140+
```
141+
142+
## Building and pushing docs
143+
144+
```bash
145+
make pushdocs
146+
```
147+
148+
Docs can be viewed at <https://wepay.github.io/signer-python/>.
136149

137150

138151
## Deploying

‎README.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,22 @@ Python at a time with `pyenv <https://github.com/yyuu/pyenv>`__.
127127
API Reference
128128
-------------
129129

130-
TBD.
130+
Building local docs
131+
~~~~~~~~~~~~~~~~~~~
132+
133+
.. code:: bash
134+
135+
make docs
136+
open docs/signer/index.html
137+
138+
Building and pushing docs
139+
-------------------------
140+
141+
.. code:: bash
142+
143+
make pushdocs
144+
145+
Docs can be viewed at https://wepay.github.io/signer-python/.
131146

132147
Deploying
133148
---------

0 commit comments

Comments
 (0)
Please sign in to comment.