Swap sphinx to autoapi and the inline stubs

Author: tannewt

.github/workflows/build.yml

@@ -34,7 +34,7 @@ jobs:
       run: |
         sudo apt-get install -y eatmydata
         sudo eatmydata apt-get install -y gettext librsvg2-bin mingw-w64
-        pip install requests sh click setuptools cpp-coveralls "Sphinx<4" sphinx-rtd-theme recommonmark sphinxcontrib-svg2pdfconverter polib pyyaml
+        pip install requests sh click setuptools cpp-coveralls "Sphinx<4" sphinx-rtd-theme recommonmark sphinx-autoapi sphinxcontrib-svg2pdfconverter polib pyyaml
     - name: Versions
       run: |
         gcc --version

.gitignore

@@ -14,6 +14,7 @@
 ############
 dist/
 *.egg-info
+.eggs
 
 # Logs and Databases
 ######################
@@ -51,6 +52,7 @@ _build
 # Generated rst files
 ######################
 genrst/
+autoapi/
 
 # ctags and similar
 ###################

Makefile

@@ -69,7 +69,7 @@ clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf $(STUBDIR) $(DISTDIR) *.egg-info
 
-html:
+html: stubs
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
@@ -213,8 +213,10 @@ check-translate: locale/circuitpython.pot $(wildcard locale/*.po)
 	$(PYTHON) tools/check_translations.py $^
 
 stubs:
+	mkdir -p circuitpython-stubs
 	python tools/extract_pyi.py shared-bindings/ $(STUBDIR)
-	#python setup.py sdist
+	python tools/extract_pyi.py ports/atmel-samd/bindings $(STUBDIR)
+	python setup.py sdist
 
 update-frozen-libraries:
 	@echo "Updating all frozen libraries to latest tagged version."

conf.py

@@ -55,7 +55,6 @@
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'rstjinja',
-    'c2rst',
     'recommonmark',
 ]
 
@@ -66,9 +65,17 @@
 source_suffix = {
     '.rst': 'restructuredtext',
     '.md': 'markdown',
-    '.c': ''
 }
 
+extensions.append('autoapi.extension')
+
+autoapi_type = 'python'
+# Uncomment this if debugging autoapi
+# autoapi_keep_files = True
+autoapi_dirs = ['circuitpython-stubs']
+autoapi_add_toctree_entry = False
+autoapi_options = ['members', 'undoc-members', 'private-members', 'show-inheritance', 'special-members', 'show-module-summary']
+autoapi_template_dir = 'docs/autoapi/templates'
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -78,7 +85,7 @@
 
 # General information about the project.
 project = 'Adafruit CircuitPython'
-copyright = '2014-2018, MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)'
+copyright = '2014-2020, MicroPython & CircuitPython contributors (https://github.com/adafruit/circuitpython/graphs/contributors)'
 
 # These are overwritten on ReadTheDocs.
 # The version info for the project you're documenting, acts as replacement for
@@ -105,6 +112,7 @@
                     ".git",
                     ".venv",
                     ".direnv",
+                    "docs/autoapi",
                     "docs/README.md",
                     "drivers",
                     "examples",

docs/c2rst.py

@@ -21,4 +21,4 @@ Port Specific modules
 ---------------------
 
 .. toctree::
-    bindings/samd/__init__
+    ../../autoapi/samd/index

ports/atmel-samd/README.rst

@@ -30,18 +30,12 @@
 #include "py/objproperty.h"
 #include "py/runtime.h"
 
-//| .. currentmodule:: samd
+//| import typing
+//| class Clock:
+//|     """Identifies a clock on the microcontroller.
 //|
-//| :class:`Clock` --- Clock reference
-//| ------------------------------------------
-//|
-//| Identifies a clock on the microcontroller.
-//|
-//| .. class:: Clock
-//|
-//|    Identifies a clock on the microcontroller. They are fixed by the
-//|    hardware so they cannot be constructed on demand. Instead, use
-//|    `samd.clock` to reference the desired clock.
+//|        They are fixed by the hardware so they cannot be constructed on demand. Instead, use
+//|        ``samd.clock`` to reference the desired clock."""
 //|
 
 STATIC void samd_clock_print(const mp_print_t *print, mp_obj_t self_in, mp_print_kind_t kind) {
@@ -50,9 +44,8 @@ STATIC void samd_clock_print(const mp_print_t *print, mp_obj_t self_in, mp_print
     mp_printf(print, "%q.%q.%q", MP_QSTR_samd, MP_QSTR_clock, self->name);
 }
 
-//|     .. attribute:: enabled
-//|
-//|       Is the clock enabled? (read-only)
+//|     enabled: bool = ...
+//|     """Is the clock enabled? (read-only)"""
 //|
 STATIC mp_obj_t samd_clock_get_enabled(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -69,9 +62,8 @@ const mp_obj_property_t samd_clock_enabled_obj = {
     },
 };
 
-//|     .. attribute:: parent
-//|
-//|       Clock parent. (read-only)
+//|     parent: typing.Union(Clock | None) = ...
+//|     """Clock parent. (read-only)"""
 //|
 STATIC mp_obj_t samd_clock_get_parent(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -98,9 +90,8 @@ const mp_obj_property_t samd_clock_parent_obj = {
     },
 };
 
-//|     .. attribute:: frequency
-//|
-//|       Clock frequency. (read-only)
+//|     frequency: int = ...
+//|     """Clock frequency in Herz. (read-only)"""
 //|
 STATIC mp_obj_t samd_clock_get_frequency(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -117,9 +108,8 @@ const mp_obj_property_t samd_clock_frequency_obj = {
     },
 };
 
-//|     .. attribute:: calibration
-//|
-//|       Clock calibration. Not all clocks can be calibrated.
+//|     calibration: int = ...
+//|     """Clock calibration. Not all clocks can be calibrated."""
 //|
 STATIC mp_obj_t samd_clock_get_calibration(mp_obj_t self_in) {
     samd_clock_obj_t *self = MP_OBJ_TO_PTR(self_in);

ports/atmel-samd/bindings/samd/Clock.c

@@ -30,29 +30,16 @@
 
 #include "bindings/samd/Clock.h"
 
-//| :mod:`samd` --- SAMD implementation settings
-//| =================================================
-//|
-//| .. module:: samd
-//|   :synopsis: SAMD implementation settings
-//|   :platform: SAMD21
-//|
-//| Libraries
-//|
-//| .. toctree::
-//|     :maxdepth: 3
-//|
-//|     Clock
-//|
+//| """SAMD implementation settings"""
 
-//| :mod:`samd.clock` --- samd clock names
+//| """:mod:`samd.clock` --- samd clock names
 //| --------------------------------------------------------
 //|
 //| .. module:: samd.clock
 //|   :synopsis: samd clock names
 //|   :platform: SAMD21
 //|
-//| References to clocks as named by the microcontroller
+//| References to clocks as named by the microcontroller"""
 //|
 const mp_obj_module_t samd_clock_module = {
     .base = { &mp_type_module },

ports/atmel-samd/bindings/samd/__init__.c

@@ -5,18 +5,16 @@
 stub_root = Path("circuitpython-stubs")
 stubs = [p.relative_to(stub_root).as_posix() for p in stub_root.glob("*.pyi")]
 
-now = datetime.utcnow()
-version = now.strftime("%Y.%m.%d")
-
 setup(
     name="circuitpython-stubs",
     description="PEP 561 type stubs for CircuitPython",
     url="https://github.com/adafruit/circuitpython",
     maintainer="CircuitPythonistas",
     author_email="[email protected]",
-    version=version,
+    use_scm_version=True,
     license="MIT",
     package_data={"circuitpython-stubs": stubs},
     packages=["circuitpython-stubs"],
-    setup_requires=["setuptools>=38.6.0"],
+    setup_requires=["setuptools>=38.6.0",
+                    "setuptools_scm"],
 )

setup.py

@@ -48,10 +48,7 @@
 #define WINDOW_DEFAULT (0.1f)
 
 //| class Adapter:
-//|     """.. currentmodule:: _bleio
-//|
-//|     :class:`Adapter` --- BLE adapter
-//|     ----------------------------------------------------
+//|     """BLE adapter
 //|
 //|     The Adapter manages the discovery and connection to other nearby Bluetooth Low Energy devices.
 //|     This part of the Bluetooth Low Energy Specification is known as Generic Access Profile (GAP).