diff --git a/doc/about.md b/doc/about.md new file mode 100644 index 0000000..030c8c2 --- /dev/null +++ b/doc/about.md @@ -0,0 +1,3 @@ +# About this code + +Work in progress ... \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..ed3aff4 --- /dev/null +++ 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" \ No newline at end of file