chore(docs): create first documentation

This commit is contained in:
Jérome Eertmans
2022-09-21 15:26:10 +02:00
parent 99ad798155
commit 3f6d2e5e57
5 changed files with 95 additions and 0 deletions

27
docs/source/conf.py Normal file
View File

@ -0,0 +1,27 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'manim-slides'
copyright = '2022, 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"]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']

11
docs/source/index.rst Normal file
View File

@ -0,0 +1,11 @@
.. 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.
Welcome to manim-slides's documentation!
========================================
.. click:: manim_slides.main:cli
:prog: manim-slides
:nested: full