feat: add .readthedocs.yaml (#80)

* feat: add .readthedocs.yaml

* feat: add requirements.txt

* feat: update .readthedocs.yaml

Author: shenxianpeng

.github/workflows/test.yml

@@ -7,6 +7,7 @@ on:
       - 'pyproject.toml'
       - 'gitstats.conf'
       - '.github/workflows/test.yml'
+      - '!docs/**'
   push:
     branches:
       - "main"

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# 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

doc/AUTHOR renamed to docs/AUTHOR.md

@@ -0,0 +1,14 @@
+# Read the Docs configuration file
+#
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+project = "GitStats"
+author = "Xianpeng Shen"
+copyright = "2024, Xianpeng Shen"
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+html_theme = "sphinx_rtd_theme"

doc/GPLv2 renamed to docs/GPLv2

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

doc/GPLv3 renamed to docs/GPLv3

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2014 Heikki Hokkanen <[email protected]> & others (see doc/AUTHOR)
+# Copyright (c) 2007-2014 Heikki Hokkanen <[email protected]> & others (see docs/AUTHOR.md)
 # GPLv2 / GPLv3
 # Copyright (c) 2024-present Xianpeng Shen <[email protected]>.
 # GPLv2 / GPLv3

doc/TODO.txt renamed to docs/TODO.md

@@ -1,4 +1,4 @@
-# Copyright (c) 2007-2014 Heikki Hokkanen <[email protected]> & others (see doc/AUTHOR)
+# Copyright (c) 2007-2014 Heikki Hokkanen <[email protected]> & others (see docs/AUTHOR.md)
 # GPLv2 / GPLv3
 # Copyright (c) 2024-present Xianpeng Shen <[email protected]>.
 # GPLv2 / GPLv3