Merge pull request #8 from AguaClara/development

Development

.travis.yml

@@ -1,21 +1,42 @@
 language: python
 sudo: false
 python:
-- '3.6'
+- '3.5'
+before_install:
+ - export NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+ - openssl aes-256-cbc -K $encrypted_0b30f5022c54_key -iv $encrypted_0b30f5022c54_iv
+  -in creds.json.enc -out creds.json -d
+addons:
+  apt:
+    packages:
+    - libcurl4-openssl-dev # required to avoid SSL errors
 install:
-- pip install -r requirements-dev.txt
+  - pip install -r requirements-dev.txt
+  - gem install html-proofer
 script:
-- pytest --cov=./
-deploy:
-  provider: pypi
-  user: "$PYPI_USERNAME"
-  password: "$PYPI_PASSWORD"
-  on:
-    tags: true
-    branch: master
-  distributions: sdist
+  - pytest --cov=./
+  - cd docs # build the docs... should be moved to before_deploy?
+  - make html
+  - make doctest
+  - htmlproofer _build/html --allow_hash_href --file_ignore "_build/html/search.html"
 after_success:
-- codecov
-before_install:
-- openssl aes-256-cbc -K $encrypted_0b30f5022c54_key -iv $encrypted_0b30f5022c54_iv
-  -in creds.json.enc -out creds.json -d
+  - codecov
+deploy:
+  - provider: pypi
+    user: "$PYPI_USERNAME"
+    password: "$PYPI_PASSWORD"
+    on:
+      tags: true
+      branch: master
+    distributions: sdist
+  - provider: pages # Deploy to to gh-pages
+    skip-cleanup: true
+    github-token: $GITHUB_TOKEN  # Set in the settings page of your repository, as a secure variable
+    keep-history: true
+    local-dir: docs/_build
+    target-branch: gh-pages
+    on:
+      tags: true
+
+
+

docs/conf.py

@@ -12,14 +12,14 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.append(os.path.join(os.path.dirname(__name__), '..'))
 
 
 # -- Project information -----------------------------------------------------
 
-project = u'onshape'
+project = u'onshapepy'
 copyright = u'2018, Ethan Keller'
 author = u'Ethan Keller'
 
@@ -46,7 +46,6 @@
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -72,6 +71,7 @@
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
 exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
+html_extra_path = [".nojekyll"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -82,7 +82,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -136,7 +136,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'aguaclaraonshape.tex', u'aguaclara.onshape Documentation',
+    (master_doc, 'aguaclaraonshape.tex', u'aguaclara.onshapepy Documentation',
      u'Ethan Keller', 'manual'),
 ]
 
@@ -146,7 +146,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'aguaclaraonshape', u'aguaclara.onshape Documentation',
+    (master_doc, 'aguaclaraonshape', u'aguaclara.onshapepy Documentation',
      [author], 1)
 ]
 
@@ -157,7 +157,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'aguaclaraonshape', u'aguaclara.onshape Documentation',
+    (master_doc, 'aguaclaraonshape', u'aguaclara.onshapepy Documentation',
      author, 'aguaclaraonshape', 'One line description of project.',
      'Miscellaneous'),
 ]

docs/modules.rst

@@ -0,0 +1,7 @@
+onshapepy
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   onshapepy

docs/onshapepy.rst

@@ -0,0 +1,54 @@
+onshapepy package
+=================
+
+Submodules
+----------
+
+onshapepy.assembly module
+-------------------------
+
+.. automodule:: onshapepy.assembly
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+onshapepy.client module
+-----------------------
+
+.. automodule:: onshapepy.client
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+onshapepy.onshape module
+------------------------
+
+.. automodule:: onshapepy.onshape
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+onshapepy.part module
+---------------------
+
+.. automodule:: onshapepy.part
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+onshapepy.utils module
+----------------------
+
+.. automodule:: onshapepy.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: onshapepy
+    :members:
+    :undoc-members:
+    :show-inheritance: