docs & README: fix the API documentation build & README

Author: stephenli2000

README.rst

@@ -1,4 +1,3 @@
-=====================
 BrainFrame Python API
 =====================
 
@@ -19,6 +18,7 @@ easy interaction with a BrainFrame server.
 
    # Connect to the server
    api = BrainFrameAPI("http://localhost")
+
    # Create a new IP camera stream
    stream_config = api.set_stream_configuration(
        bf_codecs.StreamConfiguration(
@@ -28,23 +28,54 @@ easy interaction with a BrainFrame server.
            runtime_options={},
        ))
    api.start_analyzing(stream_config.id)
+
    # Get results
    analysis_results = api.get_latest_zone_statuses()
 
+# Build brainframe-api wheel
+
+.. code-block:: bash
+
+   poetry build
+
+The output will be in dist/. Check the README format if it is updated,
+
+.. code-block:: bash
+
+   pip install readme-renderer
+   python -m readme_renderer README.rst
 
 Installation
-------------
+============
 
 The BrainFrame Python API is available on PyPI and can be installed with pip.
 Install the version of the library that matches the version of BrainFrame that
-you are using. For example, if you are using BrainFrame version 0.26.1:
+you are using.
 
 .. code-block:: bash
 
    pip3 install brainframe-api
 
+Or local build,
+
+.. code-block:: bash
+
+   pip3 install dist/{file name.whl}
+
 Documentation
--------------
+=============
+
+.. code-block:: bash
+
+   pip install sphinx sphinx-rtd-theme
+   cd docs
+   make html
+
+Read the generated docs,
+
+.. code-block:: bash
+
+   firefox _build/html/index.html
 
 Documentation for this library is available on `ReadTheDocs`_.
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

docs/capsules.rst

@@ -12,9 +12,11 @@ API Methods
 
 .. automethod:: brainframe.api.BrainFrameAPI.get_capsules
 
-.. automethod:: brainframe.api.BrainFrameAPI.set_capsule
+.. automethod:: brainframe.api.BrainFrameAPI.load_capsule
 
-.. automethod:: brainframe.api.BrainFrameAPI.delete_capsule
+.. automethod:: brainframe.api.BrainFrameAPI.upload_and_load_capsule
+
+.. automethod:: brainframe.api.BrainFrameAPI.unload_capsule
 
 .. automethod:: brainframe.api.BrainFrameAPI.get_capsule_option_vals
 
@@ -34,3 +36,4 @@ Data Structures
 
 .. _`Introduction to Capsules`:
    https://openvisioncapsules.readthedocs.io/en/latest/introduction.html
+

docs/conf.py

@@ -51,7 +51,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Mock out any third-party imports
 autodoc_mock_imports = ["requests", "numpy", "PIL"]