chore(lib): moved Sphinx directive from docs to sphinxext

This commit is contained in:
Jérome Eertmans
2025-04-18 18:55:47 +02:00
parent fbf5f42f31
commit 880cba3064
6 changed files with 8 additions and 4 deletions

View File

@ -18,6 +18,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
when using one of those extras, but as they were not part of the public API,
we do not consider this to be a **breaking change**.
[#542](https://github.com/jeertmans/manim-slides/pull/542)
- Moved `manim_slides.docs.manim_slides_directive` to `manim_slides.sphinxext.manim_slides_directive`.
This is a **breaking change** because documentation configs have
to be updated.
[#242](https://github.com/jeertmans/manim-slides/pull/242)
(v5.5.1)=
## [v5.5.1](https://github.com/jeertmans/manim-slides/compare/v5.5.0...v5.5.1)

View File

@ -37,7 +37,7 @@ extensions = [
"sphinx_copybutton",
"sphinx_design",
# Custom
"manim_slides.docs.manim_slides_directive",
"manim_slides.sphinxext.manim_slides_directive",
]
autodoc_typehints = "both"

View File

@ -1,6 +1,6 @@
# Manim Slides' Sphinx directive
```{eval-rst}
.. automodule:: manim_slides.docs.manim_slides_directive
.. automodule:: manim_slides.sphinxext.manim_slides_directive
:members: ManimSlidesDirective
```

View File

@ -116,7 +116,7 @@ class ManimSlidesMagic(Magics): # type: ignore
file) will be moved relative to the video locations. Use-cases include building
documentation with Sphinx and JupyterBook. See also the
:mod:`Manim Slides directive for Sphinx
<manim_slides.docs.manim_slides_directive>`.
<manim_slides.sphinxext.manim_slides_directive>`.
Examples
--------

View File

@ -40,7 +40,7 @@ First, you must include the directive in the Sphinx configuration file:
extensions = [
# ...
"manim_slides.docs.manim_slides_directive",
"manim_slides.sphinxext.manim_slides_directive",
]
Its basic usage that allows processing **inline content**