diff --git a/CHANGELOG.md b/CHANGELOG.md index ee684d7..fe73bb9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/docs/source/conf.py b/docs/source/conf.py index 703ee6c..90345a5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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" diff --git a/docs/source/reference/sphinx_extension.md b/docs/source/reference/sphinx_extension.md index e8685e0..e65b0f7 100644 --- a/docs/source/reference/sphinx_extension.md +++ b/docs/source/reference/sphinx_extension.md @@ -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 ``` diff --git a/manim_slides/ipython/ipython_magic.py b/manim_slides/ipython/ipython_magic.py index 62ca96e..32231d2 100644 --- a/manim_slides/ipython/ipython_magic.py +++ b/manim_slides/ipython/ipython_magic.py @@ -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 - `. + `. Examples -------- diff --git a/manim_slides/docs/__init__.py b/manim_slides/sphinxext/__init__.py similarity index 100% rename from manim_slides/docs/__init__.py rename to manim_slides/sphinxext/__init__.py diff --git a/manim_slides/docs/manim_slides_directive.py b/manim_slides/sphinxext/manim_slides_directive.py similarity index 99% rename from manim_slides/docs/manim_slides_directive.py rename to manim_slides/sphinxext/manim_slides_directive.py index 720ffae..f89d706 100644 --- a/manim_slides/docs/manim_slides_directive.py +++ b/manim_slides/sphinxext/manim_slides_directive.py @@ -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**