🔧 Add sphinx-lint

* 🔧 Install sphinx-lint
* 🔧 Update pre-commit config
* 🔧 Update readthedocs config
* 🚚 Move content to docs directory

Author: veit

.pre-commit-config.yaml

@@ -24,3 +24,9 @@ repos:
     hooks:
       - id: flake8
         language_version: python3
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v0.7.0
+    hooks:
+    - id: sphinx-lint
+      args: [--jobs=1]
+      types: [rst]

.readthedocs.yaml

@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: conf.py
+  configuration: docs/conf.py
 
 # Build PDF & ePub
 formats:

README.rst

@@ -23,19 +23,22 @@ numpy==1.24.2
 packaging==23.0
 Pillow==9.4.0
 platformdirs==2.6.2
+polib==1.2.0
 pre-commit==3.0.4
 Pygments==2.14.0
 pyparsing==3.0.9
 python-dateutil==2.8.2
 pytz==2022.7.1
 PyYAML==6.0
+regex==2023.10.3
 requests==2.28.2
 six==1.16.0
 snowballstemmer==2.2.0
 soupsieve==2.3.2.post1
 Sphinx==5.3.0
 sphinx-basic-ng==1.0.0b1
 sphinx-copybutton==0.5.1
+sphinx-lint==0.7.0
 sphinx_design==0.3.0
 sphinxcontrib-applehelp==1.0.4
 sphinxcontrib-devhelp==1.0.2