Skip to content

Commit 55d5b83

Browse files
committed
starting docs
1 parent a9fcc65 commit 55d5b83

14 files changed

Lines changed: 512 additions & 5 deletions

File tree

.travis.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ after_success:
2424
- ls -lha
2525
- bash <(curl -s https://codecov.io/bash)
2626

27+
env:
28+
- secure: "WnCglysfnXwLAlzgJAkkOvXmQdYMqdPoSu820IFzg4ul1bh75i1b1C8jmxECESXew5IGAbmgjSBYErKeYktT9EMpXkSNRMF7k64JhbN9D8Fr5IhB62UfuJc/u0vIf/6mJc8oByvVCsJ+9i8PzJ98BBQMduFtsh3RjU+JoClcE+H+u1ieH7L23/lEq+no9iUbJyPg6LOHmfbU5YIP5hTHYqNIHnx8/0jwI9UhFXfFzPIl0smyECKNR3BOj/4Mntd5gFq3XNXf5MZir0gZhmg+J79POC0JqzUXGnZy27Dw6xPnOVOuIwjib6qcquM1cCAq1wRExab5p4CskmWqGkAwYMbrh15Za6Xzvt7iuP91aAptffHh1ztT2Ff48fXY354ZF2u5hfEsSV3O4kPz8LfOOiox0Vw+ohUvxfkg9NphpbOfwgPpL+TdMjhIjnnVBLOSE4UMlIxbFGmM2HooW18mXoPXCu66nm+Rz7jsXuV8OsamRWqvqd58pNbzyuxhUZwM3CzggT/1qAIhN8tEzBjL7Klei5fHgU+2Nm5T0m4s+UJNRCwJn/k6cOF2vxYMbjTxFsquoOd98aXGpCWUtOwzyjNz+6SA4ltlrUJnMpgXLAp+Z0qSfZJP9FUzjryWbfsQdmUhcYfAe5BFFegcQPmcJnQ127r5CqP+l3vO+H7Eetw="
29+
2730
deploy:
2831
- provider: pypi
2932
user: samuelcolvin
@@ -34,3 +37,8 @@ deploy:
3437
on:
3538
tags: true
3639
python: 3.6
40+
- provider: script
41+
script: make publish
42+
on:
43+
tags: true
44+
python: 3.6

HISTORY.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.. :changelog:
2+
3+
History
4+
-------
5+
6+
v0.3.0 (2017-10-XX)
7+
...................
8+
* allow ``async/await`` arguments
9+
* fix subscript
10+
* fix weird named tuples eg ``mock > call_args``
11+
12+
v0.2.0 (2017-09-14)
13+
...................
14+
* improve output
15+
* numerous bug fixes

Makefile

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ clean:
5555
docs:
5656
make -C docs html
5757

58-
.PHONY: docs-lint
59-
docs-lint:
60-
make -C docs lint
58+
.PHONY: publish
59+
publish: docs
60+
cd docs/_build/ && cp -r html site && zip -r site.zip site
61+
@curl -H "Content-Type: application/zip" -H "Authorization: Bearer ${NETLIFY}" \
62+
--data-binary "@docs/_build/site.zip" https://api.netlify.com/api/v1/sites/pydantic-docs.netlify.com/deploys

dev-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#-r docs/requirements.txt
1+
-r docs/requirements.txt
22
-r tests/requirements.txt
33

44
astpretty # pyup: ignore

devtools/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
__all__ = ['VERSION']
44

5-
VERSION = StrictVersion('0.2.0')
5+
VERSION = StrictVersion('0.3.0')

docs/Makefile

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# You can set these variables from the command line.
2+
SPHINXOPTS = -W
3+
SPHINXBUILD = sphinx-build
4+
PAPER =
5+
BUILDDIR = _build
6+
STATICDIR = _static
7+
8+
# Internal variables.
9+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
10+
11+
.PHONY: clean
12+
clean:
13+
rm -rf $(BUILDDIR)
14+
15+
.PHONY: html
16+
html: clean
17+
mkdir -p $(STATICDIR)
18+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
19+
@echo
20+
@echo "Build finished. open file://`pwd`/_build/html/index.html"
21+
22+
.PHONY: linkcheck
23+
linkcheck:
24+
mkdir -p $(STATICDIR)
25+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
26+
@echo
27+
@echo "Link check complete; look for any errors in the above output " \
28+
"or in $(BUILDDIR)/linkcheck/output.txt."

docs/_templates/layout.html

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{% extends '!layout.html' %}
2+
3+
{% block footer %}
4+
<script>
5+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
6+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
7+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
8+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
9+
ga('create', 'UA-62733018-4', 'auto');
10+
ga('send', 'pageview');
11+
</script>
12+
{% endblock %}

0 commit comments

Comments
 (0)