From 31a30f380f32eac030c5c63764eb6e00a3c475d1 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Tue, 3 Aug 2021 13:18:53 +0200 Subject: [PATCH] doc/common/requirements: Rename to static. We will work on a version that can be toggled dynamically. It will just include this static version. This keeps things simple and still lets us use the static version as needed. --- doc/common/conf.py | 2 +- .../extensions/{requirements.py => requirements-static.py} | 6 +++--- doc/main/iodevices/index.rst | 2 +- doc/main/micropython/umath.rst | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) rename doc/common/extensions/{requirements.py => requirements-static.py} (94%) diff --git a/doc/common/conf.py b/doc/common/conf.py index 1bff8e0..8bff9ea 100644 --- a/doc/common/conf.py +++ b/doc/common/conf.py @@ -60,7 +60,7 @@ extensions = [ 'sphinx.ext.mathjax', 'color', 'classlink', - 'requirements', + 'requirements-static', ] # Add any paths that contain templates here, relative to this directory. diff --git a/doc/common/extensions/requirements.py b/doc/common/extensions/requirements-static.py similarity index 94% rename from doc/common/extensions/requirements.py rename to doc/common/extensions/requirements-static.py index fd69170..39caeca 100644 --- a/doc/common/extensions/requirements.py +++ b/doc/common/extensions/requirements-static.py @@ -29,7 +29,7 @@ HUB_FEATURES = { } -class PybricksRequirementsDirective(Directive): +class PybricksRequirementsStaticDirective(Directive): required_arguments = 0 optional_arguments = 10 @@ -88,6 +88,6 @@ class PybricksRequirementsDirective(Directive): def setup(app): app.add_directive_to_domain( 'py', - 'pybricks-requirements', - PybricksRequirementsDirective + 'pybricks-requirements-static', + PybricksRequirementsStaticDirective ) diff --git a/doc/main/iodevices/index.rst b/doc/main/iodevices/index.rst index 2c170d3..17b618e 100644 --- a/doc/main/iodevices/index.rst +++ b/doc/main/iodevices/index.rst @@ -13,7 +13,7 @@ This module has classes for generic input/output devices. It is available on these hubs: -.. pybricks-requirements:: pybricks-iodevices +.. pybricks-requirements-static:: pybricks-iodevices .. pybricks-classlink:: PUPDevice diff --git a/doc/main/micropython/umath.rst b/doc/main/micropython/umath.rst index 501b53b..6477f1e 100644 --- a/doc/main/micropython/umath.rst +++ b/doc/main/micropython/umath.rst @@ -4,7 +4,7 @@ This MicroPython module is similar to the `math module`_ in Python. It is available on these hubs: -.. pybricks-requirements:: stm32-extra stm32-float +.. pybricks-requirements-static:: stm32-extra stm32-float .. module:: umath