docs changed to sphinx-rtd-theme, initial attempt

.gitignore

@@ -103,3 +103,15 @@ ENV/
 
 # Visual Studio Code
 .vscode/
+
+# ------------------------------------------------------------------------------
+# docs & rhino
+# ------------------------------------------------------------------------------
+
+docs/reference/generated/
+
+*.3dmbak
+*.rhl
+
+temp/**
+!temp/.gitkeep

.travis.yml

@@ -14,44 +14,17 @@
 language: python
 
 python:
-  - "2.7"
+#   - "2.7"
   - "3.6"
 
-# * use these when not using a conda env
 before_install:
-- pip install Cython --install-option="--no-cython-compile"
+# - pip install Cython --install-option="--no-cython-compile"
 - pip install cmake
 install:
 - pip install --no-cache-dir -r requirements-dev.txt
 
-# install:
-#   - sudo apt-get update
-#   # We do this conditionally because it saves us some downloading if the
-#   # version is the same.
-#   - if [[ "$TRAVIS_PYTHON_VERSION" == "2.7" ]]; then
-#       wget https://repo.continuum.io/miniconda/Miniconda2-latest-Linux-x86_64.sh -O miniconda.sh;
-#     else
-#       wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
-#     fi
-#   - bash miniconda.sh -b -p $HOME/miniconda
-#   - source "$HOME/miniconda/etc/profile.d/conda.sh"
-#   - hash -r
-#   - conda config --set always_yes yes --set changeps1 no
-#   - conda update -q conda
-#   # Useful for debugging any issues with conda
-#   - conda info -a
-#   - conda env create -f test_env.yml python=$TRAVIS_PYTHON_VERSION
-#   - conda activate test_env
-#   - pip install Cython --install-option="--no-cython-compile"
-#   - pip install --no-cache-dir -r requirements-dev.txt
-#  # Replace dep1 dep2 ... with your dependencies
-#   - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION dep1 dep2 ...
-
 script:
 - pip install ikfast_pybind
 - invoke test
-# - if [[ "$TRAVIS_PYTHON_VERSION" == "3.6" ]]; then
-#     invoke docs;
-#   fi
 after_success:
   - coveralls

CHANGELOG.rst

@@ -7,6 +7,14 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+
+Unreleased
+----------
+
+**Changed**
+
+* Changed doc theme to sphinx-rtd-theme, doc hosted on readthedocs
+
 0.1.1
 ----------
 

README.rst

@@ -4,9 +4,9 @@ pybullet_planning
 
 .. start-badges
 
-.. image:: https://img.shields.io/badge/License-MIT-blue.svg
-    :target: https://github.com/yijiangh/pybullet_planning/blob/master/LICENSE
-    :alt: License MIT
+.. image:: https://readthedocs.org/projects/pybullet-planning/badge/?version=latest
+    :target: https://pybullet-planning.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
 
 
 .. image:: https://travis-ci.com/yijiangh/pybullet_planning.svg?branch=master
@@ -18,78 +18,86 @@ pybullet_planning
     :target: https://coveralls.io/github/yijiangh/pybullet_planning?branch=master
     :alt: Coveralls
 
+
+.. image:: https://img.shields.io/badge/License-MIT-blue.svg
+    :target: https://github.com/yijiangh/pybullet_planning/blob/master/LICENSE
+    :alt: License MIT
+
 .. end-badges
 
 .. Write project description
 
-*pybullet_planning* is a suite of utility functions to facilitate robotic planning related research on the `pybullet <https://github.com/bulletphysics/bullet3>`_ physics simulation engine.
+**pybullet_planning** is a suite of utility functions to facilitate robotic planning related research on the `pybullet <https://github.com/bulletphysics/bullet3>`_ physics simulation engine.
 
 
 Main features
 -------------
 
-* feature
+* easy-to-use functions to connect with pybullet, tailored for task and motion planning research
+* built-in implementations of standard motion planners, including PRM, RRT, biRRT, A* etc.
 
-**pybullet_planning** runs on Python 2.5+ and 3.x.
 
+Getting Started
+---------------
 
-Documentation
--------------
+**pybullet_planning** can be installed using ``pip``:
 
-.. Explain how to access documentation: API, examples, etc.
+::
 
-..
-.. optional sections:
+    pip install pybullet_planning
 
-Requirements
-------------
 
-.. Write requirements instructions here
+.. note::
 
+    On Windows, you may need to install
+    `Microsoft Visual C++ 14.0 <https://www.scivision.co/python-windows-visual-c++-14-required/>`_.
 
-Installation
-------------
 
-.. Write installation instructions here
+Once the installation is completed, you can verify your setup.
+Start Python from the command prompt and run the following:
 
+::
 
-Contributing
-------------
+    >>> import pybullet_planning
 
-Make sure you setup your local development environment correctly:
 
-* Clone the `pybullet_planning <https://github.com/yijiangh/pybullet_planning>`_ repository.
-* Install development dependencies:
+First Steps
+---------------
 
-::
+* `Documentation <https://pybullet-planning.readthedocs.io>`_
+
+Contributing
+------------
 
-    pip install -r requirements-dev.txt
+We love contributions!
 
-**You're ready to start working!**
+Check the `Contributor's Guide <./CONTRIBUTING.rst>`_
+for more details.
 
-During development, use tasks on the
-command line to ease recurring operations:
+Releasing this project
+----------------------
 
-* ``invoke clean``: Clean all generated artifacts.
-* ``invoke check``: Run various code and documentation style checks.
-* ``invoke docs``: Generate documentation.
-* ``invoke test``: Run all tests and checks in one swift command.
-* ``invoke``: Show available tasks.
+Ready to release a new version of **pybullet_planning**? Here's how to do it:
 
-For more details, check the `Contributor's Guide <CONTRIBUTING.rst>`_.
+* We use `semver <https://semver.org/>`_, i.e. we bump versions as follows:
 
+  * ``patch``: bugfixes.
+  * ``minor``: backwards-compatible features added.
+  * ``major``: backwards-incompatible changes.
 
-Releasing this project
-----------------------
+* Update the ``CHANGELOG.rst`` with all novelty!
+* Ready? Release everything in one command:
+
+::
 
-.. Write releasing instructions here
+    invoke release [patch|minor|major]
+    # with -b to bump version
 
+* Celebrate! 💃
 
-.. end of optional sections
-..
 
 Credits
 -------------
 
 This package was initiated by Caelan Garrett <[email protected]> `@caelan <https://github.com/caelan>`_,
-with some maintainence from Yijiang Huang <[email protected]> `@yijiangh <https://github.com/yijiangh>`_.
+and other `contributors <./AUTHORS.rst>`_.

docs/conf.py

@@ -2,6 +2,31 @@
 from __future__ import unicode_literals
 
 import os
+import sphinx_rtd_theme
+
+# -- General configuration ------------------------------------------------
+
+project = 'pybullet_planning'
+year = '2020'
+author = 'Caelan Garrett & Yijiang Huang'
+copyright = '{0}, {1}'.format(year, author)
+version = release = '0.1.1'
+
+master_doc = 'index'
+source_suffix = '.rst'
+# templates_path = ['_templates', ]
+exclude_patterns = ['_build', '**.ipynb_checkpoints', '_notebooks']
+
+pygments_style = 'sphinx'
+show_authors = True
+add_module_names = True
+
+extlinks = {
+    'issue': ('https://github.com/yijiangh/pybullet_planning/issues/%s', '#'),
+    'pr': ('https://github.com/yijiangh/pybullet_planning/pull/%s', 'PR #'),
+}
+
+# -- Extension configuration ------------------------------------------------
 
 extensions = [
     'sphinx.ext.autodoc',
@@ -13,46 +38,59 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    "sphinx_rtd_theme",
 ]
 if os.getenv('SPELLCHECK'):
     extensions += 'sphinxcontrib.spelling',
     spelling_show_suggestions = True
     spelling_lang = 'en_US'
 
-source_suffix = '.rst'
-master_doc = 'index'
-project = 'pybullet_planning'
-year = '2019'
-author = 'Caelan Garrett'
-copyright = '{0}, {1}'.format(year, author)
-version = release = '0.1.1'
+# intersphinx options
+# intersphinx_mapping = {'python': ('https://docs.python.org/', None),
+#                        'roslibpy': ('http://roslibpy.readthedocs.org/en/latest/', None)}
 
-pygments_style = 'trac'  # Perhaps change to sphinx
-templates_path = ['.']
-extlinks = {
-    'issue': ('https://github.com/yijiangh/pybullet_planning/issues/%s', '#'),
-    'pr': ('https://github.com/yijiangh/pybullet_planning/pull/%s', 'PR #'),
+# autodoc options
+autodoc_default_options = {
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'exclude-members': '__weakref__',
+    'undoc-members': True,
+    'private-members': True,
+    'show-inheritance': True,
 }
+
+autodoc_member_order = 'alphabetical'
+
+# autosummary options
+autosummary_generate = True
+
 # on_rtd is whether we are on readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
-html_theme = 'alabaster'
-html_theme_options = {
-    # 'logo': 'logo.png',
-    'description': 'pybullet_planning',
-    'github_user': 'yijiangh',
-    'github_repo': project,
-    'fixed_sidebar': True,
-}
+# on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+html_theme = "sphinx_rtd_theme"
+# options: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
+
+# napoleon options
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = True
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = False
+napoleon_use_rtype = False
+
+# -- Options for HTML output ----------------------------------------------
 
-html_use_smartypants = True
-html_last_updated_fmt = '%b %d, %Y'
 html_split_index = False
-html_static_path = ['_static']
-html_sidebars = {
-   '**': ['about.html', 'navigation.html', 'searchbox.html'],
-}
 html_short_title = '%s-%s' % (project, version)
-
-napoleon_use_ivar = True
-napoleon_use_rtype = False
-napoleon_use_param = False
+html_context = {}
+html_static_path = ['_static']
+html_last_updated_fmt = '%b %d, %Y'
+html_copy_source = False
+html_show_sourcelink = False
+html_add_permalinks = ''
+html_experimental_html5_writer = True
+html_compact_lists = True

docs/index.rst

@@ -4,14 +4,25 @@ pybullet_planning
 
 .. start-badges
 
+.. image:: https://readthedocs.org/projects/pybullet-planning/badge/?version=latest
+    :target: https://pybullet-planning.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+
+.. image:: https://travis-ci.com/yijiangh/pybullet_planning.svg?branch=master
+    :target: https://travis-ci.com/yijiangh/pybullet_planning
+    :alt: Travis CI
+
+
+.. image:: https://coveralls.io/repos/github/yijiangh/pybullet_planning/badge.svg?branch=master
+    :target: https://coveralls.io/github/yijiangh/pybullet_planning?branch=master
+    :alt: Coveralls
+
+
 .. image:: https://img.shields.io/badge/License-MIT-blue.svg
     :target: https://github.com/yijiangh/pybullet_planning/blob/master/LICENSE
     :alt: License MIT
 
-.. .. image:: https://travis-ci.org/yijiangh/pybullet_planning.svg?branch=master
-..     :target: https://travis-ci.org/yijiangh/pybullet_planning
-..     :alt: Travis CI
-
 .. end-badges
 
 .. Write project description
@@ -25,17 +36,11 @@ Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
+   :titlesonly:
 
    readme
-   reference/index
+   reference
    contributing
    authors
    changelog
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/reference.rst

@@ -0,0 +1,10 @@
+.. _reference:
+
+*************
+API Reference
+*************
+
+.. toctree::
+    :maxdepth: 2
+
+    reference/pybullet_planning