Progress on sphinx autodocs

Author: ksiegall

XRPLib/version.py

@@ -1,2 +1,2 @@
 # Last updated 29-June-2023
-__version__ = '0.8'
+__version__ = '0.9'

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   ?= "C:\Users\origi\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts\sphinx-build.exe"
+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/api.rst

@@ -4,75 +4,77 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
-Hardware
--------
+API Reference
+=============
 
-.. autoclass:: XRPLib.motor
+Hardware
+--------
+.. autoclass:: motor.Motor
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.encoded_motor
+.. autoclass:: encoded_motor.EncodedMotor
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.motor_group
+.. autoclass:: motor_group.MotorGroup
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.differential_drive
+.. autoclass:: differential_drive.DifferentialDrive
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.servo
+.. autoclass:: servo.Servo
     :members:
     :undoc-members:
 
 Sensors
 -------
 
-.. autoclass:: XRPLib.encoder
+.. autoclass:: encoder.Encoder
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.imu
+.. autoclass:: imu.IMU
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.rangefinder
+.. autoclass:: rangefinder.Rangefinder
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.reflectance
+.. autoclass:: reflectance.Reflectance
     :members:
     :undoc-members:
 
 Miscellaneous
--------
+-------------
 
-.. autoclass:: XRPLib.board
+.. autoclass:: board.Board
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.controller
+.. autoclass:: controller.Controller
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.defaults
+.. automodule:: defaults
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.pid
+.. autoclass:: pid.PID
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.resetbot
+.. automodule:: resetbot
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.version
+.. automodule:: version
     :members:
     :undoc-members:
 
-.. autoclass:: XRPLib.webserver
+.. autoclass:: webserver.Webserver
     :members:
     :undoc-members:

docs/conf.py

@@ -7,9 +7,10 @@
 import os
 import sys
 import datetime
-from XRPLib.version import __version__
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../XRPLib"))
+
+from version import __version__
 
 # -- General configuration ------------------------------------------------
 

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=C:\Users\origi\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts\sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd