diff --git a/README.md b/README.md index 1ec7c5d..f8a0a56 100644 --- a/README.md +++ b/README.md @@ -41,13 +41,20 @@ high-level elements on top. In order to learn how to set up the project in development mode, please visit the [development documentation]. +## Acknowledgements + +Kudos to [Chris Sewell] and all contributors for conceiving and maintaining +[MyST Parser] and [sphinx-design]. + [Changelog]: https://github.com/panodata/sphinx-design-elements/blob/main/CHANGES.md +[Chris Sewell]: https://github.com/chrisjsewell [development documentation]: https://sphinx-design-elements.readthedocs.io/en/latest/sandbox.html [Documentation]: https://sphinx-design-elements.readthedocs.io/ [Issues]: https://github.com/panodata/sphinx-design-elements/issues [License]: https://github.com/panodata/sphinx-design-elements/blob/main/LICENSE +[MyST Parser]: https://myst-parser.readthedocs.io/ [PyPI]: https://pypi.org/project/sphinx-design-elements/ [Source code]: https://github.com/panodata/sphinx-design-elements [sphinx-design]: https://sphinx-design.readthedocs.io/ diff --git a/docs/gridtable.md b/docs/gridtable.md index 4a7611f..8224bc8 100644 --- a/docs/gridtable.md +++ b/docs/gridtable.md @@ -29,6 +29,8 @@ elsewhere. Basic table, two columns, no formatting. +:::::{div} sd-shadow-md + ::::{sd-table} :widths: 3 9 @@ -57,6 +59,7 @@ Taxi quer durch Bayern. ::: :::: +::::: ## Usage diff --git a/docs/index.md b/docs/index.md index 21fb3b3..7efb0fb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,7 +38,7 @@ Get Started :::::: -Building upon sphinx{design} +Building upon sphinx{design} and Flexbox : [sphinx-design] is a Sphinx extension for designing beautiful, screen-size responsive web-components. It is inspired by the [Bootstrap], [Material Design], and [Material-UI] design frameworks, and uses [CSS Flexible Box Layout], commonly diff --git a/tests/conftest.py b/tests/conftest.py index 7132e92..bb2065e 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -12,6 +12,12 @@ class SphinxBuilder: + """ + Sphinx builder fixture implementation for pytest. + + TODO: Currently copied from `sphinx-design`. Maybe import from there instead? + """ + def __init__(self, app: SphinxTestApp, src_path: Path): self.app = app self._src_path = src_path @@ -59,6 +65,12 @@ def get_doctree(self, docname: str, post_transforms: bool = False) -> nodes.docu @pytest.fixture() def sphinx_builder(tmp_path: Path, make_app, monkeypatch): + """ + Sphinx builder fixture entrypoint for pytest. + + TODO: Currently copied from `sphinx-design`. Maybe import from there instead? + """ + def _create_project(buildername: str = "html", conf_kwargs: Optional[Dict[str, Any]] = None): src_path = tmp_path / "srcdir" src_path.mkdir()