🔧 Add sphinx-lint

* 🔧 Install sphinx-lint * 🔧 Update pre-commit config * 🔧 Update readthedocs config * 🚚 Move content to docs directory
python-berlin · Oct 15, 2023 · fb63d04 · fb63d04
1 parent 3643d7f
commit fb63d04
Show file tree

Hide file tree

Showing 58 changed files with 13 additions and 2 deletions.
diff --git a/.pre-commit-config.yaml b/.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]
diff --git a/.readthedocs.yaml b/.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:

diff --git a/README.rst b/README.rst
@@ -31,7 +31,7 @@ Download and installation
 
     $ cd python.berlin
     $ $ python3 -m venv .
-    $ source bin/activate
+    $ . bin/activate
     $ python -m pip install --upgrade pip
     $ python -m pip install -r requirements_dev.txt
     $ pre-commit install
@@ -40,4 +40,5 @@ Download and installation
 
    .. code-block:: console
 
+    $ cd docs
     $ make html
diff --git a/constraints.txt b/constraints.txt
@@ -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

diff --git a/Makefile → docs/Makefile b/Makefile → docs/Makefile
diff --git a/_build/.gitkeep → docs/_build/.gitkeep b/_build/.gitkeep → docs/_build/.gitkeep
diff --git a/_static/images/logo/favicon.ico → docs/_static/images/logo/favicon.ico b/_static/images/logo/favicon.ico → docs/_static/images/logo/favicon.ico
diff --git a/_static/images/logo/logo.png → docs/_static/images/logo/logo.png b/_static/images/logo/logo.png → docs/_static/images/logo/logo.png
diff --git a/collaboration.rst → docs/collaboration.rst b/collaboration.rst → docs/collaboration.rst
diff --git a/conf.py → docs/conf.py b/conf.py → docs/conf.py
diff --git a/django-user-group-berlin/index.rst → docs/django-user-group-berlin/index.rst b/django-user-group-berlin/index.rst → docs/django-user-group-berlin/index.rst
diff --git a/django-user-group-berlin/logo.jpg → docs/django-user-group-berlin/logo.jpg b/django-user-group-berlin/logo.jpg → docs/django-user-group-berlin/logo.jpg
diff --git a/djangogirls-berlin/index.rst → docs/djangogirls-berlin/index.rst b/djangogirls-berlin/index.rst → docs/djangogirls-berlin/index.rst
diff --git a/djangogirls-berlin/logo.png → docs/djangogirls-berlin/logo.png b/djangogirls-berlin/logo.png → docs/djangogirls-berlin/logo.png
diff --git a/index.rst → docs/index.rst b/index.rst → docs/index.rst
diff --git a/make.bat → docs/make.bat b/make.bat → docs/make.bat
diff --git a/opentechschool-berlin/index.rst → docs/opentechschool-berlin/index.rst b/opentechschool-berlin/index.rst → docs/opentechschool-berlin/index.rst
diff --git a/opentechschool-berlin/logo.png → docs/opentechschool-berlin/logo.png b/opentechschool-berlin/logo.png → docs/opentechschool-berlin/logo.png
diff --git a/pub/index.rst → docs/pub/index.rst b/pub/index.rst → docs/pub/index.rst
diff --git a/pub/logo.png → docs/pub/logo.png b/pub/logo.png → docs/pub/logo.png
diff --git a/pub/reference-library/index.rst → docs/pub/reference-library/index.rst b/pub/reference-library/index.rst → docs/pub/reference-library/index.rst
diff --git a/...opyright-software-licenses-and-python.pdf → ...opyright-software-licenses-and-python.pdf b/...opyright-software-licenses-and-python.pdf → ...opyright-software-licenses-and-python.pdf
diff --git a/...opyright-software-licenses-and-python.png → ...opyright-software-licenses-and-python.png b/...opyright-software-licenses-and-python.png → ...opyright-software-licenses-and-python.png
diff --git a/...esources/AsyncIO_ Python Users Berlin.pdf → ...esources/AsyncIO_ Python Users Berlin.pdf b/...esources/AsyncIO_ Python Users Berlin.pdf → ...esources/AsyncIO_ Python Users Berlin.pdf
diff --git a/...ions - Python Users Berlin - Nov 2020.pdf → ...ions - Python Users Berlin - Nov 2020.pdf b/...ions - Python Users Berlin - Nov 2020.pdf → ...ions - Python Users Berlin - Nov 2020.pdf
diff --git a/pub/resources/Rust-for-Pythonistas.pdf → docs/pub/resources/Rust-for-Pythonistas.pdf b/pub/resources/Rust-for-Pythonistas.pdf → docs/pub/resources/Rust-for-Pythonistas.pdf
diff --git a/pub/resources/asyncio-friends.png → docs/pub/resources/asyncio-friends.png b/pub/resources/asyncio-friends.png → docs/pub/resources/asyncio-friends.png
diff --git a/pub/resources/deta-pub-slides.pdf → docs/pub/resources/deta-pub-slides.pdf b/pub/resources/deta-pub-slides.pdf → docs/pub/resources/deta-pub-slides.pdf
diff --git a/pub/resources/deta-pub-slides.png → docs/pub/resources/deta-pub-slides.png b/pub/resources/deta-pub-slides.png → docs/pub/resources/deta-pub-slides.png
diff --git a/pub/resources/great-expectations.png → docs/pub/resources/great-expectations.png b/pub/resources/great-expectations.png → docs/pub/resources/great-expectations.png
diff --git a/pub/resources/index.rst → docs/pub/resources/index.rst b/pub/resources/index.rst → docs/pub/resources/index.rst
diff --git a/pub/resources/ip-in-python.pdf → docs/pub/resources/ip-in-python.pdf b/pub/resources/ip-in-python.pdf → docs/pub/resources/ip-in-python.pdf
diff --git a/pub/resources/ip-in-python.png → docs/pub/resources/ip-in-python.png b/pub/resources/ip-in-python.png → docs/pub/resources/ip-in-python.png
diff --git a/...reira-fredes_building-python-projects.pdf → ...reira-fredes_building-python-projects.pdf b/...reira-fredes_building-python-projects.pdf → ...reira-fredes_building-python-projects.pdf
diff --git a/...reira-fredes_building-python-projects.png → ...reira-fredes_building-python-projects.png b/...reira-fredes_building-python-projects.png → ...reira-fredes_building-python-projects.png
diff --git a/pub/resources/practical-data-privacy.pdf → .../pub/resources/practical-data-privacy.pdf b/pub/resources/practical-data-privacy.pdf → .../pub/resources/practical-data-privacy.pdf
diff --git a/pub/resources/practical-data-privacy.png → .../pub/resources/practical-data-privacy.png b/pub/resources/practical-data-privacy.png → .../pub/resources/practical-data-privacy.png
diff --git a/...-pyberlin-meetup-overview-june-7-2023.pdf → ...-pyberlin-meetup-overview-june-7-2023.pdf b/...-pyberlin-meetup-overview-june-7-2023.pdf → ...-pyberlin-meetup-overview-june-7-2023.pdf
diff --git a/...-pyberlin-meetup-overview-june-7-2023.png → ...-pyberlin-meetup-overview-june-7-2023.png b/...-pyberlin-meetup-overview-june-7-2023.png → ...-pyberlin-meetup-overview-june-7-2023.png
diff --git a/pub/resources/pyodide_pub_2023-04-13.pdf → .../pub/resources/pyodide_pub_2023-04-13.pdf b/pub/resources/pyodide_pub_2023-04-13.pdf → .../pub/resources/pyodide_pub_2023-04-13.pdf
diff --git a/pub/resources/pyodide_pub_2023-04-13.png → .../pub/resources/pyodide_pub_2023-04-13.png b/pub/resources/pyodide_pub_2023-04-13.png → .../pub/resources/pyodide_pub_2023-04-13.png
diff --git a/pub/resources/rust-for-pythonistas.png → docs/pub/resources/rust-for-pythonistas.png b/pub/resources/rust-for-pythonistas.png → docs/pub/resources/rust-for-pythonistas.png
diff --git a/pub/resources/sending-million-pushes.pdf → .../pub/resources/sending-million-pushes.pdf b/pub/resources/sending-million-pushes.pdf → .../pub/resources/sending-million-pushes.pdf
diff --git a/pub/resources/sending-million-pushes.png → .../pub/resources/sending-million-pushes.png b/pub/resources/sending-million-pushes.png → .../pub/resources/sending-million-pushes.png
diff --git a/pub/resources/sqlparse_pub_2021-08-04.pdf → ...pub/resources/sqlparse_pub_2021-08-04.pdf b/pub/resources/sqlparse_pub_2021-08-04.pdf → ...pub/resources/sqlparse_pub_2021-08-04.pdf
diff --git a/pub/resources/sqlparse_pub_2021-08-04.png → ...pub/resources/sqlparse_pub_2021-08-04.png b/pub/resources/sqlparse_pub_2021-08-04.png → ...pub/resources/sqlparse_pub_2021-08-04.png
diff --git a/pub/resources/teaching-python.png → docs/pub/resources/teaching-python.png b/pub/resources/teaching-python.png → docs/pub/resources/teaching-python.png
diff --git a/pub/resources/teaching_python.pdf → docs/pub/resources/teaching_python.pdf b/pub/resources/teaching_python.pdf → docs/pub/resources/teaching_python.pdf
diff --git a/...lugin-friendly-applications-in-python.pdf → ...lugin-friendly-applications-in-python.pdf b/...lugin-friendly-applications-in-python.pdf → ...lugin-friendly-applications-in-python.pdf
diff --git a/...lugin-friendly-applications-in-python.png → ...lugin-friendly-applications-in-python.png b/...lugin-friendly-applications-in-python.png → ...lugin-friendly-applications-in-python.png
diff --git a/pub/wish-list.rst → docs/pub/wish-list.rst b/pub/wish-list.rst → docs/pub/wish-list.rst
diff --git a/pyberlin/index.rst → docs/pyberlin/index.rst b/pyberlin/index.rst → docs/pyberlin/index.rst
diff --git a/pyberlin/logo.png → docs/pyberlin/logo.png b/pyberlin/logo.png → docs/pyberlin/logo.png
diff --git a/pydata-berlin/index.rst → docs/pydata-berlin/index.rst b/pydata-berlin/index.rst → docs/pydata-berlin/index.rst
diff --git a/pydata-berlin/logo.png → docs/pydata-berlin/logo.png b/pydata-berlin/logo.png → docs/pydata-berlin/logo.png
diff --git a/pyladies-berlin/index.rst → docs/pyladies-berlin/index.rst b/pyladies-berlin/index.rst → docs/pyladies-berlin/index.rst
diff --git a/pyladies-berlin/logo.png → docs/pyladies-berlin/logo.png b/pyladies-berlin/logo.png → docs/pyladies-berlin/logo.png
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,3 +1,4 @@
 -r requirements.txt
 
 pre-commit
+sphinx-lint