Enhance documentation (issue #3)

* update requirements * update .readthedocs.yaml * remove auto-generated files and update build process * update documents
binh-vu · Jul 24, 2022 · 491689e · 491689e
1 parent 398c341
commit 491689e
Show file tree

Hide file tree

Showing 22 changed files with 106 additions and 445 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "3.9"
+  jobs:
+    pre_build:
+      - cp CHANGELOG.md docs/source/changelog.md
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Changelog
+# CHANGE LOG
 
 ## [2.3.3](https://github.com/binh-vu/kgdata/tree/2.3.3) (2022-07-06)
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,9 @@
-furo
-sphinx
+furo>=2022.6.21,<2023.0.0
+sphinx>=5.0.2,<6.0.0
 sphinxcontrib.katex
 matplotlib
 sphinx-copybutton
 sphinx-panels
-sphinx-autodoc-typehints
+sphinx-autodoc-typehints
+myst-parser==0.18.0
+sphinx-autobuild  # needed for doc development
diff --git a/docs/source/.gitignore b/docs/source/.gitignore
@@ -0,0 +1,2 @@
+apis
+CHANGELOG.md
diff --git a/docs/source/apis/kgdata.spark.rst b/docs/source/apis/kgdata.spark.rst
diff --git a/docs/source/apis/kgdata.splitter.rst b/docs/source/apis/kgdata.splitter.rst
diff --git a/docs/source/apis/kgdata.wikidata.db.rst b/docs/source/apis/kgdata.wikidata.db.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.multilingual.rst b/docs/source/apis/kgdata.wikidata.models.multilingual.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.propertystats.rst b/docs/source/apis/kgdata.wikidata.models.propertystats.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.rst b/docs/source/apis/kgdata.wikidata.models.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.wdclass.rst b/docs/source/apis/kgdata.wikidata.models.wdclass.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.wdentity.rst b/docs/source/apis/kgdata.wikidata.models.wdentity.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.wdentitylabel.rst b/docs/source/apis/kgdata.wikidata.models.wdentitylabel.rst
diff --git a/docs/source/apis/kgdata.wikidata.models.wdproperty.rst b/docs/source/apis/kgdata.wikidata.models.wdproperty.rst