chore(docs): improving the docs (#115)

* chore(docs): improving the docs

This improves the docs as suggested by some reddit user. Now, most of Manim is documented in one place

* try: update lockfile

* chore(deps): remove duplicate key

* fix(ci): isort issue

See https://github.com/home-assistant/core/issues/86892

* fix(ci): bad identation

* fix(ci): fixing lock file

* fix(example): issue when ManimGL does not count wait as animation

docs/source/changelog.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Changes between releases are listed in Manim Slides' [Github releases](https://github.com/jeertmans/manim-slides/releases). You can read the [latest release here](https://github.com/jeertmans/manim-slides/releases).

docs/source/conf.py

@@ -8,13 +8,19 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Manim Slides"
-copyright = "2022, Jérome Eertmans"
+copyright = "2023, Jérome Eertmans"
 author = "Jérome Eertmans"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc", "sphinx_click"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx_click",
+    "myst_parser",
+    "sphinx_copybutton",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []

docs/source/contributing/index.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thank you for your interest in Manim Slides! ✨
+
+Manim Slides is an open source project, first created as a fork of [manim-presentation](https://github.com/galatolofederico/manim-presentation) (now deprecated in favor to Manim Slides), and we welcome contributions of all forms.
+
+This section is here to help fist-time contributors know how they can help this project grow. Whether you are already familiar with Manim or GitHub, it is worth taking a few minutes to read those documents!
+
+
+```{toctree}
+:hidden:
+
+workflow
+internals
+```
+
+[Workflow](./workflow)
+: how to work on this project. Start here if you're a new contributor.
+
+[Internals](./internals)
+: how Manim Slides is built and how the various parts of it work.

docs/source/contributing/internals.md

@@ -0,0 +1,11 @@
+# Internals
+
+Manim-Slides' work in split in two steps: first, when rendering animation, and, second, when converting multiple animations into one slides presentation.
+
+## Rendering
+
+To render animations, Manim Slides simply uses Manim or ManimGL, and creates some additional output files that it needs for the presentation.
+
+## Slides presentation
+
+Manim Slides searches for the local artifacts it generated previously, and concatenates them into one presentation. For the graphical interface, it uses `PySide6`.

docs/source/contributing/workflow.md

@@ -0,0 +1,57 @@
+# Workflow
+
+This document is there to help you recreate a working environment for Manim Slides.
+
+## Dependencies
+
+```{include} ../../../README.md
+:start-after: <!-- start deps -->
+:end-before: <!-- end deps -->
+```
+
+## Forking the repository and cloning it locally
+
+We used GitHub to host Manim Slides' repository, and we encourage contributors to use git.
+
+Useful links:
+
+* [GitHub's Hello World](https://docs.github.com/en/get-started/quickstart/hello-world).
+* [GitHub Pull Request in 100 Seconds](https://www.youtube.com/watch?v=8lGpZkjnkt4&ab_channel=Fireship).
+
+Once you feel comfortable with git and GitHub, [fork](https://github.com/jeertmans/manim-slides/fork) the repository, and clone it locally.
+
+As for every Python project, using virtual environment is recommended to avoid conflicts between modules. For Manim Slides, we use [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer). If not already, please install it.
+
+## Installing Python modules
+
+With Poetry, installation becomes straightforward:
+
+```bash
+poetry install
+```
+
+## Running commands
+
+As modules were installed in a new Python environment, you cannot use them directly in the shell.
+Instead, you either need to prepend `poetry run` to any command, e.g.:
+
+```bash
+poetry run manim-slides wizard
+```
+
+or enter a new shell that uses this new Python environment:
+
+```
+poetry run
+manim-slides wizard
+```
+
+## Testing your code
+
+Most of the tests are done with GitHub actions, thus not on your computer. The only command you should run locally is `pre-commit run --all-files`: this runs a few linter and formatter to make sure the code quality and style stay constant across time. If a warning or an error is displayed, please fix it before going to next step.
+
+## Proposing changes
+
+Once you feel ready and think your contribution is ready to be reviewed, create a [pull request](https://github.com/jeertmans/manim-slides/pulls) and wait for a reviewer to check your work!
+
+Many thanks to you!

docs/source/index.md

@@ -0,0 +1,36 @@
+---
+hide-toc: true
+---
+
+<p align="center><img src="_static/logo.png" width="600px" alt="Manim Slides logo"></p>
+
+# Welcome to Manim Slide's documentation
+
+Manim Slides makes creating slides with Manim super easy!
+
+In a [very few steps](./quickstart), you can create slides and present them either using the GUI, or your browser.
+
+
+Slide through the demo below to get a quick glimpse on what you can do with Manin Slides.
+
+
+<!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
+
+
+```{toctree}
+:hidden:
+
+quickstart
+reference/index
+```
+
+```{toctree}
+:caption: Development
+:hidden:
+
+contributing/index
+changelog
+license
+```

docs/source/index.rst

@@ -1,28 +0,0 @@
-.. manim-slides documentation master file, created by
-   sphinx-quickstart on Wed Sep 21 15:07:28 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: _static/logo.png
-    :width: 600px
-    :align: center
-    :alt: Manim Slide logo
-
-Welcome to Manim Slide's CLI documentation!
-===========================================
-
-
-.. raw:: html
-
-   <!-- From: https://faq.dailymotion.com/hc/en-us/articles/360022841393-How-to-preserve-the-player-aspect-ratio-on-a-responsive-page -->
-
-   <div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/slides.html"></iframe></div>
-
-
-This page contains an exhaustive list of all the commands available with `manim-slides`.
-
-If you need help installing or using Manim Slide, please refer to the `GitHub README <https://github.com/jeertmans/manim-slides>`_.
-
-.. click:: manim_slides.__main__:cli
-    :prog: manim-slides
-    :nested: full

docs/source/license.md

@@ -0,0 +1,5 @@
+# License
+
+
+```{include} ../../LICENSE.md
+```

docs/source/quickstart.md

@@ -0,0 +1,21 @@
+# Quickstart
+
+## Installation
+
+```{include} ../../README.md
+:start-after: <!-- start install -->
+:end-before: <!-- end install -->
+```
+
+## Creating your first slides
+
+```{include} ../../README.md
+:start-after: <!-- start usage -->
+:end-before: <!-- end usage -->
+```
+
+The output slides should look this this:
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="_static/basic_example.html"></iframe></div>
+
+For more advanced examples, see the [Examples](reference/examples) section.

docs/source/reference/api.md

@@ -0,0 +1,13 @@
+# Application Programming Interface
+
+Manim Slides' API is very limited: it simply consists in two classes, `Slide` and `ThreeDSlide`, which are subclasses of `Scene` and `ThreeDScene` from Manim.
+
+Thefore, we only document here the methods we think the end-user will ever use, not the methods used internally when rendering.
+
+```{eval-rst}
+.. autoclass:: manim_slides.Slide
+    :members: start_loop, end_loop, pause, play
+
+.. autoclass:: manim_slides.ThreeDSlide
+    :members:
+```

docs/source/reference/cli.md

@@ -0,0 +1,10 @@
+# Command Line Interface
+
+This page contains an exhaustive list of all the commands available with `manim-slides`.
+
+
+```{eval-rst}
+.. click:: manim_slides.__main__:cli
+    :prog: manim-slides
+    :nested: full
+```

docs/source/reference/examples.md

@@ -0,0 +1,59 @@
+# Examples
+
+Contents of `example.py`.
+
+Do not forget to import Manim Slides and Manim or ManimGL.
+
+## Basic Example
+
+Basic example from quickstart.
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: BasicExample
+```
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/basic_example.html"></iframe></div>
+
+## 3D Example
+
+Example using 3D camera. As Manim and ManimGL handle 3D differently, definitions are slightly different.
+
+### With Manim
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manim-3d]
+   :end-before: [manim-3d]
+```
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/three_d_example.html"></iframe></div>
+
+### With ManimGL
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :dedent: 4
+   :start-after: [manimgl-3d]
+   :end-before: [manimgl-3d]
+```
+
+## Advanced Example
+
+A more advanced example is `ConvertExample`, which is used as demo slide and tutorial.
+
+```{eval-rst}
+.. literalinclude:: ../../../example.py
+   :language: python
+   :linenos:
+   :pyobject: ConvertExample
+```
+
+<div style="position:relative;padding-bottom:56.25%;"> <iframe style="width:100%;height:100%;position:absolute;left:0px;top:0px;" frameborder="0" width="100%" height="100%" allowfullscreen allow="autoplay" src="../_static/slides.html"></iframe></div>

docs/source/reference/index.md

@@ -0,0 +1,17 @@
+# Reference Documentation
+
+Automatically generated reference for Manim Slides.
+
+```{toctree}
+:hidden:
+
+api
+cli
+examples
+```
+
+[Application Programming Interface](./api): list of classes and methods that may be useful to the end-user.
+
+[Command Line Interface](./cli): list of all commands available using Manim Slides' executable.
+
+[Examples](./examples): curated list of examples and their output.