Skip to content

Commit

Permalink
Documentation: This and that
Browse files Browse the repository at this point in the history
  • Loading branch information
amotl committed Jul 19, 2023
1 parent 69e110e commit 7cd8667
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand Down
3 changes: 3 additions & 0 deletions docs/gridtable.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ elsewhere.

Basic table, two columns, no formatting.

:::::{div} sd-shadow-md

::::{sd-table}
:widths: 3 9

Expand Down Expand Up @@ -57,6 +59,7 @@ Taxi quer durch Bayern.
:::

::::
:::::


## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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()
Expand Down

0 comments on commit 7cd8667

Please sign in to comment.