Update documentation (#1381)

* Convert docs to markdown * Remove unused file * Add missing dependencies * Add HF Spaces deployment * New section in customizing voila
voila-dashboards · Aug 16, 2023 · f55c446 · f55c446
1 parent 7c6fce9
commit f55c446
Show file tree

Hide file tree

Showing 24 changed files with 1,492 additions and 1,944 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,3 @@
+```{include} ../CHANGELOG.md
+
+```
diff --git a/docs/source/conf.py → docs/conf.py b/docs/source/conf.py → docs/conf.py
@@ -3,7 +3,7 @@
 # Add dev disclaimer.
 _release = {}
 exec(
-    compile(open("../../voila/_version.py").read(), "../../voila/_version.py", "exec"),
+    compile(open("../voila/_version.py").read(), "../voila/_version.py", "exec"),
     _release,
 )
 if _release["version_info"][-1] == "dev":
@@ -21,25 +21,23 @@
 html_theme_options = {"github_url": "https://github.com/voila-dashboards/voila"}
 
 
-def setup(app):
-    app.add_css_file("main_stylesheet.css")
-
-
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
+    "sphinxcontrib.video",
+    "myst_parser",
 ]
 
-html_static_path = ["_static"]
-source_suffix = ".rst"
+myst_enable_extensions = ["colon_fence"]
+source_suffix = ".md"
 master_doc = "index"
 project = "voila"
 copyright = "2020, The Voilà Development Team"
 author = "The Voilà Development Team"
 version = ".".join(map(str, _release["version_info"][:2]))
 release = _release["__version__"]
-language = None
+language = "en"
 
 html_logo = "voila-logo.svg"
 
@@ -49,4 +47,6 @@ def setup(app):
 todo_include_todos = False
 htmlhelp_basename = "voiladoc"
 
-intersphinx_mapping = {"https://docs.python.org/": None}
+intersphinx_mapping = {"python": ("https://docs.python.org", None)}
+
+myst_heading_anchors = 3