improve pdoc landing site by rendering the README contents in the ind…

…ex.html. closes #332
open-atmos · May 29, 2024 · f3479db · f3479db
1 parent 202a02b
commit f3479db
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/PyPartMC/__init__.py b/PyPartMC/__init__.py
@@ -1,3 +1,7 @@
+"""
+.. include::../README.md
+"""
+
 # pylint: disable=invalid-name,wrong-import-position
 import os
 from collections import namedtuple