building and pushing docs

Author: feynmanliang

MANIFEST.in

@@ -9,4 +9,7 @@ include tox.ini
 recursive-include labelbox *.py
 recursive-include tests *.json
 recursive-include tests *.py
+recursive-include docs *.py
+recursive-include docs *.rst
+
 include labelbox/exporters/pascal_voc_writer/templates/annotation.xml

README.md

@@ -38,3 +38,9 @@ To generate a `requirements.txt` for usage outside of `pipenv`
 ```sh
 pipenv lock -r > requirements.txt
 ```
+
+## Publishing docs
+
+```sh
+./build-docs.sh
+```

build-docs.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+# build the docs
+pipenv run tox -e docs
+
+# commit and push
+git add -A
+git commit -m "building and pushing docs"
+git push origin master
+
+# switch branches and pull the data we want
+git checkout gh-pages
+rm -rf .
+git checkout master docs/build/html
+mv ./docs/build/html/* ./
+rm -rf ./docs
+git add -A
+git commit -m "publishing updated docs..."
+git push origin gh-pages
+
+# switch back
+git checkout master

docs/conf.py

@@ -41,9 +41,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinxcontrib.napoleon',
-    'sphinx.ext.doctest',
     'sphinx.ext.todo',
-    'sphinx.ext.coverage',
+    'sphinx.ext.githubpages',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

labelbox/predictions/__init__.py

@@ -9,7 +9,7 @@
 def vectorize_to_v4_label(
         segmentation_map,
         legend: Dict[int, str],
-        epsilon: Optional[float]) -> DefaultDict[str, List[dict]]:
+        epsilon: Optional[float] = None) -> DefaultDict[str, List[dict]]:
     """Converts a segmentation map into polygons.
 
     Given a raster pixel wise array of predictions in `segmentation_map`,

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = labelbox
-version = 0.0.1
+version = 0.0.2
 description = A python library for interacting with labelbox.com
 author = Feynman Liang
 author_email = feynman@labelbox.com

tox.ini

@@ -29,9 +29,9 @@ commands=
         labelbox/ tests/
 
 [testenv:docs]
-basepython = python3.6
 commands =
     pipenv install --dev --ignore-pipfile
+    rm -rf docs/_build docs/source
     pipenv run sphinx-apidoc -f -o docs/source --implicit-namespaces labelbox
     pipenv run sphinx-build -W -b html docs docs/_build/html