mirror of
https://github.com/jeertmans/manim-slides.git
synced 2025-08-23 12:33:38 +08:00
chore(lib): moved Sphinx directive from docs
to sphinxext
This commit is contained in:
@ -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,
|
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**.
|
we do not consider this to be a **breaking change**.
|
||||||
[#542](https://github.com/jeertmans/manim-slides/pull/542)
|
[#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)=
|
||||||
## [v5.5.1](https://github.com/jeertmans/manim-slides/compare/v5.5.0...v5.5.1)
|
## [v5.5.1](https://github.com/jeertmans/manim-slides/compare/v5.5.0...v5.5.1)
|
||||||
|
@ -37,7 +37,7 @@ extensions = [
|
|||||||
"sphinx_copybutton",
|
"sphinx_copybutton",
|
||||||
"sphinx_design",
|
"sphinx_design",
|
||||||
# Custom
|
# Custom
|
||||||
"manim_slides.docs.manim_slides_directive",
|
"manim_slides.sphinxext.manim_slides_directive",
|
||||||
]
|
]
|
||||||
|
|
||||||
autodoc_typehints = "both"
|
autodoc_typehints = "both"
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Manim Slides' Sphinx directive
|
# Manim Slides' Sphinx directive
|
||||||
|
|
||||||
```{eval-rst}
|
```{eval-rst}
|
||||||
.. automodule:: manim_slides.docs.manim_slides_directive
|
.. automodule:: manim_slides.sphinxext.manim_slides_directive
|
||||||
:members: ManimSlidesDirective
|
:members: ManimSlidesDirective
|
||||||
```
|
```
|
||||||
|
@ -116,7 +116,7 @@ class ManimSlidesMagic(Magics): # type: ignore
|
|||||||
file) will be moved relative to the video locations. Use-cases include building
|
file) will be moved relative to the video locations. Use-cases include building
|
||||||
documentation with Sphinx and JupyterBook. See also the
|
documentation with Sphinx and JupyterBook. See also the
|
||||||
:mod:`Manim Slides directive for Sphinx
|
:mod:`Manim Slides directive for Sphinx
|
||||||
<manim_slides.docs.manim_slides_directive>`.
|
<manim_slides.sphinxext.manim_slides_directive>`.
|
||||||
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
|
@ -40,7 +40,7 @@ First, you must include the directive in the Sphinx configuration file:
|
|||||||
|
|
||||||
extensions = [
|
extensions = [
|
||||||
# ...
|
# ...
|
||||||
"manim_slides.docs.manim_slides_directive",
|
"manim_slides.sphinxext.manim_slides_directive",
|
||||||
]
|
]
|
||||||
|
|
||||||
Its basic usage that allows processing **inline content**
|
Its basic usage that allows processing **inline content**
|
Reference in New Issue
Block a user