File tree Expand file tree Collapse file tree 3 files changed +34
-5
lines changed Expand file tree Collapse file tree 3 files changed +34
-5
lines changed Original file line number Diff line number Diff line change @@ -34,12 +34,13 @@ test:
34
34
35
35
.PHONY : docs
36
36
docs :
37
+ pdoc --html --html-dir docs --overwrite --all-submodules --external-links wepay/signer
37
38
38
39
.PHONY : pushdocs
39
40
pushdocs : docs
40
41
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/
43
44
cd /tmp/gh-pages/ && git add . && git commit -a -m " Automated commit on $$ (date)" && git push origin gh-pages
44
45
45
46
# -------------------------------------------------------------------------------
62
63
@ if [ $$ (git status -s -uall | wc -l) != 0 ]; then echo ' ERROR: Git workspace must be clean.' ; exit 1; fi ;
63
64
64
65
@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 '."
66
67
@echo "---------------------------------------------------------------------"
67
68
@read -p "Press any key to continue, or press Control+C to cancel. " x;
68
69
Original file line number Diff line number Diff line change @@ -132,7 +132,20 @@ We use [tox] to handle local testing across multiple versions of Python. We inst
132
132
133
133
## API Reference
134
134
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/ > .
136
149
137
150
138
151
## Deploying
Original file line number Diff line number Diff line change @@ -127,7 +127,22 @@ Python at a time with `pyenv <https://github.com/yyuu/pyenv>`__.
127
127
API Reference
128
128
-------------
129
129
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/.
131
146
132
147
Deploying
133
148
---------
You can’t perform that action at this time.
0 commit comments