Update all docstrings (#155)

* add autoapi to reqs

* fix API Reference title

* checkpoint

* update

* lint

* finish up

* lint

* sphinx cosmetics

* pylint

* mypy

* consistent example style

* lint

* typo: frame -> scene for scene method

* add AsyncJob example usage

* update links

* fix typehint

* fix optional typehints

* annotation and prediction constructor examples

* examples for API instantiations

* JSON-like -> JSON

* update -> overwrite (metadata)

* fix

* fix scene and model

* fix quaternion

* example fillins: str -> global

Author: drakejwong

docs/_templates/python/module.rst

@@ -2,8 +2,8 @@
 :orphan:
 
 {% endif %}
-:py:mod:`{{ obj.name }}`
-=========={{ "=" * obj.name|length }}
+API Reference
+=============
 
 .. py:module:: {{ obj.name }}
 

docs/conf.py

@@ -54,6 +54,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
+html_title = "Nucleus API Reference"
 html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -77,7 +78,7 @@
 autoapi_dirs = ["../nucleus"]
 autoapi_options = [
     "members",
-    "undoc-members",  # TODO: no-undoc-members once all docstrings are populated
+    "no-undoc-members",
     "inherited-members",
     "show-module-summary",
     "imported-members",
@@ -87,4 +88,5 @@
 autoapi_python_class_content = "both"
 autoapi_member_order = "groupwise"
 autodoc_typehints = "description"
+autoapi_add_toctree_entry = False
 napoleon_include_init_with_doc = True

docs/index.rst

@@ -1,12 +1,7 @@
-.. Nucleus documentation master file, created by
-   sphinx-quickstart on Mon Oct 18 13:08:57 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+Welcome to the Nucleus API Reference!
+=====================================
 
-Welcome to Nucleus's documentation!
-===================================
-
-Aggregate metrics in ML are not good enough. To improve production ML, you need to understand their qualitative failure modes, fix them by gathering more data, and curate diverse scenarios.
+Aggregate metrics in ML are not good enough. To improve production ML, you need to understand qualitative failure modes, fix them by gathering more data, and curate diverse scenarios.
 
 Scale Nucleus helps you:
 
@@ -17,21 +12,28 @@ Scale Nucleus helps you:
 
 Nucleus is a new way—the right way—to develop ML models, helping us move away from the concept of one dataset and towards a paradigm of collections of scenarios.
 
-Check out the :doc:`usage` section for further information, including how to :ref:`install <installation>` the client.
+.. _installation:
+Installation
+------------
+
+To use Nucleus, first install it using `pip`:
+
+.. code-block:: console
 
+   (venv) $ pip install scale-nucleus
 
-Contents
+
+.. _api:
+Sections
 --------
 
 .. toctree::
    :maxdepth: 4
 
-   usage
-   api
+   api/nucleus/index
+
 
-Indices and tables
-==================
+Index
+-----
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/requirements.txt

@@ -1,2 +1,3 @@
+sphinx-autoapi
 sphinx
 furo