We add files expected by sphinx

balmorelcommunity · Sep 16, 2024 · 74cd5b2 · 74cd5b2
1 parent 8cfacd0
commit 74cd5b2
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/doc/about.md b/doc/about.md
@@ -0,0 +1,3 @@
+# About this code
+
+Work in progress ...
diff --git a/doc/conf.py b/doc/conf.py
@@ -0,0 +1,16 @@
+project = "pybalmorel"
+copyright = "2024, Authors"
+author = "Mathias Berg Rosendal, Théodore Le Nalinec"
+release = "0.3.4"
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+extensions = [
+    "myst_parser",  # in order to use markdown
+]
+
+myst_enable_extensions = [
+    "colon_fence",  # ::: can be used instead of ``` for better rendering
+]
+
+html_theme = "sphinx_rtd_theme"