Skip to content

Commit 7cd8667

Browse files
committed
Documentation: This and that
1 parent 69e110e commit 7cd8667

File tree

4 files changed

+23
-1
lines changed

4 files changed

+23
-1
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,20 @@ high-level elements on top.
4141
In order to learn how to set up the project in development mode, please visit the
4242
[development documentation].
4343

44+
## Acknowledgements
45+
46+
Kudos to [Chris Sewell] and all contributors for conceiving and maintaining
47+
[MyST Parser] and [sphinx-design].
48+
4449

4550

4651
[Changelog]: https://github.com/panodata/sphinx-design-elements/blob/main/CHANGES.md
52+
[Chris Sewell]: https://github.com/chrisjsewell
4753
[development documentation]: https://sphinx-design-elements.readthedocs.io/en/latest/sandbox.html
4854
[Documentation]: https://sphinx-design-elements.readthedocs.io/
4955
[Issues]: https://github.com/panodata/sphinx-design-elements/issues
5056
[License]: https://github.com/panodata/sphinx-design-elements/blob/main/LICENSE
57+
[MyST Parser]: https://myst-parser.readthedocs.io/
5158
[PyPI]: https://pypi.org/project/sphinx-design-elements/
5259
[Source code]: https://github.com/panodata/sphinx-design-elements
5360
[sphinx-design]: https://sphinx-design.readthedocs.io/

docs/gridtable.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ elsewhere.
2929

3030
Basic table, two columns, no formatting.
3131

32+
:::::{div} sd-shadow-md
33+
3234
::::{sd-table}
3335
:widths: 3 9
3436

@@ -57,6 +59,7 @@ Taxi quer durch Bayern.
5759
:::
5860

5961
::::
62+
:::::
6063

6164

6265
## Usage

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Get Started
3838

3939
::::::
4040

41-
Building upon sphinx{design}
41+
Building upon sphinx{design} and Flexbox
4242
: [sphinx-design] is a Sphinx extension for designing beautiful, screen-size
4343
responsive web-components. It is inspired by the [Bootstrap], [Material Design],
4444
and [Material-UI] design frameworks, and uses [CSS Flexible Box Layout], commonly

tests/conftest.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212

1313

1414
class SphinxBuilder:
15+
"""
16+
Sphinx builder fixture implementation for pytest.
17+
18+
TODO: Currently copied from `sphinx-design`. Maybe import from there instead?
19+
"""
20+
1521
def __init__(self, app: SphinxTestApp, src_path: Path):
1622
self.app = app
1723
self._src_path = src_path
@@ -59,6 +65,12 @@ def get_doctree(self, docname: str, post_transforms: bool = False) -> nodes.docu
5965

6066
@pytest.fixture()
6167
def sphinx_builder(tmp_path: Path, make_app, monkeypatch):
68+
"""
69+
Sphinx builder fixture entrypoint for pytest.
70+
71+
TODO: Currently copied from `sphinx-design`. Maybe import from there instead?
72+
"""
73+
6274
def _create_project(buildername: str = "html", conf_kwargs: Optional[Dict[str, Any]] = None):
6375
src_path = tmp_path / "srcdir"
6476
src_path.mkdir()

0 commit comments

Comments
 (0)