refactor!: remove sphinx plugin (#29)

The plugin was not generic and in fact very opinionated on the structure of the generated output.
DataDog · Dec 8, 2023 · 11581fc · 11581fc
1 parent 8862de6
commit 11581fc
Show file tree

Hide file tree

Showing 7 changed files with 0 additions and 352 deletions.
diff --git a/README.md b/README.md
@@ -89,27 +89,6 @@ to use it, either install the library with the `mypy` extra or ensure that
 the `mypy` configuration.
 
 
-## Sphinx Plugin
-
-The library comes with a Sphinx plugin at `envier.sphinx` to allow generating
-documentation from the configuration spec class directly. It exposes the
-``envier`` directive that takes a mandatory argument, the configuration spec
-class in the form `module:class`; additionally, the options `heading` and
-`recursive` can be used to control whether to add heading and whether to
-recursively get help information from nested configuration spec classes
-respectively. By default, the plugin will display the table heading and will not
-recurse over nested configuration spec classes.
-
-Here is an example for a configuration class `GlobalConfig` located in the
-`myapp.config` module. We omit the table header and recurse over nested
-configuration.
-
-~~~ rst
-.. envier:: myapp.config:GlobalConfig
-   :heading: false
-   :recursive: true
-~~~
-
 ## Roadmap
 
 - Add support for environment files.

diff --git a/envier/sphinx.py b/envier/sphinx.py
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/sphinx/test-root/_build/index.html b/tests/sphinx/test-root/_build/index.html
diff --git a/tests/sphinx/test-root/conf.py b/tests/sphinx/test-root/conf.py
diff --git a/tests/sphinx/test-root/index.rst b/tests/sphinx/test-root/index.rst
diff --git a/tests/test_sphinx.py b/tests/test_sphinx.py