fixup! feat: add .readthedocs.yaml (#80)

Author: shenxianpeng

.readthedocs.yaml

@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.13"
+    python: "3.12"
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
@@ -17,6 +17,6 @@ sphinx:
 # Optionally, but recommended,
 # declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/AUTHOR.md

@@ -1,3 +1,5 @@
+# Author
+
 Author can be reached by sending e-mail to <[email protected]>.
 
 Include "gitstats" in the subject or prepare to battle the spam filters.

docs/TODO.md

@@ -1,3 +1,5 @@
+# TODO
+
 []
 - cleanup: use defaultdict(int) for counting dicts instead of foo[x] = foo.get(x, 0) + 1
 	- not supported in python 2.4 - do any users use python 2.4?

docs/conf.py

@@ -7,8 +7,12 @@
 author = "Xianpeng Shen"
 copyright = "2024, Xianpeng Shen"
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.napoleon",
-    "sphinx.ext.viewcode",
+    "myst_parser",
 ]
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+
 html_theme = "sphinx_rtd_theme"

docs/index.rst

@@ -0,0 +1,12 @@
+Welcome to GitStats documentation!
+==================================
+
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :hidden:
+
+   AUTHOR.md
+   TODO.md

docs/requirements.txt

@@ -1,3 +1,4 @@
+myst-parser
 # Defining the exact version will make sure things don't break
 sphinx==5.3.0
 sphinx_rtd_theme==1.1.1