[FX-92] V11.0.7 beta (#114)

* Adds training-related functions.

* Bumps version and lints.

* Adds homepage to pyproject file.

* Makes links in readme absolute so they work correctly on pypi. See FX-92.

* Fixed typo in demo2.

* Starts migration to sphinx and rst for docs.

* Ports install docs to rst. Adds theming scaffolding.

* Finishes porting docstrings to rst.

* Ports quickstart to rst.

* Adds links to methods in quickstart.

* Lints.

* Updates css for docs.

* Fixes issue 116.

* Fixes docs dark mode colors. Fixes typos in docs.

* Adds a config file for read the docs.

* Adds requirements.txt to docs for readthedocs.

* Instructs rtd to install the package to be able to access the version.

* Updates readme links to use rtd.

* Switches from D logo to Dephy logo.

* Fixes path to new logo.

* Adds logo. It had been ignored by gitignore.

* Adds favicon file.

---------

Co-authored-by: Jared <jcoughlin@dephy.com>

.readthedocs.yaml

@@ -0,0 +1,34 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#    - pdf
+#    - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .

README.md

@@ -6,7 +6,7 @@ It can be used for gathering data from a device or for writing your own controll
 
 ## Installation
 
-Please see the installation documentation [here](./docs/install.md) for detailed
+Please see the installation documentation [here](https://flexsea.readthedocs.io/en/latest/installing/index.html) for detailed
 installation instructions.
 
 
@@ -19,7 +19,7 @@ that live in the `demos/` directory. The demos are numbered and should be viewed
 order, as each successive demo builds off of the information presented in the previous
 one. Each demo has verbose comments explaining each step.
 
-You can also find a quickstart guide [here](./docs/quickstart.md)
+You can also find a quickstart guide [here](https://flexsea.readthedocs.io/en/latest/quickstart.html)
 
 
 ## Testing
@@ -47,7 +47,7 @@ python3 ./test_open_control.py
 
 ### API Overview
 
-Please see the api documentation [here](./docs/api.md).
+Please see the api documentation [here](https://flexsea.readthedocs.io/en/latest/api/index.html).
 
 
 ## Contributing

demos/demo2.py

@@ -55,7 +55,7 @@
 # positions: the initial position and then the initial position plus
 # some offset. The motor position is given in "ticks", and the
 # conversion between ticks and degrees depends on the device. For an
-# actpack, the conversion is 350 degrees = 16384 ticks
+# actpack, the conversion is 360 degrees = 16384 ticks
 offset = 1000
 pos0 = data["mot_ang"]
 positions = [pos0, pos0 + offset]

demos/demo3.py

@@ -23,11 +23,11 @@
 #                   clear
 # ============================================
 def clear() -> None:
-    try:
-        sub.run(
-            ["cls" if "windows" == platform.system().lower() else "clear"], check=True
-        )
-    except FileNotFoundError:
+    if platform.system().lower() == "windows":
+        # https://stackoverflow.com/a/24306385/8087342
+        # Solves Issue #116
+        sub.run(["cls"], check=True, shell=True)
+    else:
         sub.run(["clear"], check=True)
 
 

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    ?= -E -a
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+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)