Add readthedocs related configuration and information

nanoy42 · May 31, 2020 · 11db60b · 11db60b
1 parent 6be95fb
commit 11db60b
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,19 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+    configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+    - pdf
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # DinoMail
 
+[![Documentation Status](https://readthedocs.org/projects/dinomail/badge/?version=latest)](https://dinomail.readthedocs.io/en/latest/?badge=latest)
+
 DinoMail is a simple webapp to manage virtual domains, users and aliases.
 
 It has been firstly developped to work with postfix and dovecot, following the tutorial here : https://workaround.org/ispmail
@@ -23,6 +25,10 @@ DinoMail
  * will not configure the mail stack for you
  * will not be reponsible for any lost emails (see license part)
 
+## Documentation
+
+DinoMail documentation can be found at https://dinomail.readthedocs.io/en/latest/.
+
 ## Screenshots
 
 ![home](https://github.com/nanoy42/DinoMail/raw/master/res/screenshots/home.png "Home page")

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -53,3 +53,6 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+master_doc = "index"
+