diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index 04f2c0a3d..511b87cbd 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -14,6 +14,9 @@ build:
jobs:
pre_build:
- python ./scripts/_locale.py --compile
+ post_build:
+ - rstcheck -r . # lint rst files
+ # - rstfmt --check --diff -w 120 . # check rst formatting
# Build documentation in the docs/ directory with Sphinx
sphinx:
@@ -27,4 +30,3 @@ formats: all
python:
install:
- requirements: requirements-dev.txt
- system_packages: true
diff --git a/.rstcheck.cfg b/.rstcheck.cfg
new file mode 100644
index 000000000..4e8e4d38a
--- /dev/null
+++ b/.rstcheck.cfg
@@ -0,0 +1,9 @@
+# configuration file for rstcheck, an rst linting tool
+# https://rstcheck.readthedocs.io/en/latest/usage/config
+
+[rstcheck]
+ignore_directives =
+ automodule,
+ include,
+ mdinclude,
+ todo,
diff --git a/docs/source/about/build.rst b/docs/source/about/build.rst
index 9fd313201..bc7212c8c 100644
--- a/docs/source/about/build.rst
+++ b/docs/source/about/build.rst
@@ -1,13 +1,13 @@
Build
=====
-RetroArcher binaries are built using `pyinstaller `_. Cross compilation is not
+RetroArcher binaries are built using `pyinstaller `__. Cross compilation is not
supported. That means the binaries must be built on the target operating system and architecture.
Use Python 3.7+
Clone
-----
-Ensure `git `_ is installed and run the following:
+Ensure `git `__ is installed and run the following:
.. code-block:: bash
git clone https://github.com/lizardbyte/retroarcher.git
diff --git a/docs/source/contributing/contributing.rst b/docs/source/contributing/contributing.rst
index 217bda130..a50300d23 100644
--- a/docs/source/contributing/contributing.rst
+++ b/docs/source/contributing/contributing.rst
@@ -2,4 +2,4 @@ Contributing
============
Read our contribution guide in our organization level
-`docs `_.
+`docs `__.
diff --git a/docs/source/contributing/localization.rst b/docs/source/contributing/localization.rst
index c95d3101d..89ca32467 100644
--- a/docs/source/contributing/localization.rst
+++ b/docs/source/contributing/localization.rst
@@ -1,23 +1,13 @@
Localization
============
-RetroArcher is being localized into various languages. The default language is `en` (English) and is highlighted green.
+RetroArcher is being localized into various languages. The default language is `en` (English).
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=de&style=for-the-badge&query=%24.progress.0.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=green&label=en&style=for-the-badge&query=%24.progress.1.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-GB&style=for-the-badge&query=%24.progress.2.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=en-US&style=for-the-badge&query=%24.progress.3.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=es-ES&style=for-the-badge&query=%24.progress.4.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=fr&style=for-the-badge&query=%24.progress.5.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=it&style=for-the-badge&query=%24.progress.6.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-.. image:: https://img.shields.io/badge/dynamic/json?color=blue&label=ru&style=for-the-badge&query=%24.progress.7.data.translationProgress&url=https%3A%2F%2Fbadges.awesome-crowdin.com%2Fstats-15178612-503340.json
-
-Graph
- .. image:: https://badges.awesome-crowdin.com/translation-15178612-503340.png
+.. image:: https://badges.awesome-crowdin.com/translation-15178612-606145.png
CrowdIn
-------
The translations occur on
-`CrowdIn `_. Feel free to contribute to localization there.
+`CrowdIn `__. Feel free to contribute to localization there.
Only elements of the interface are planned to be translated.
Translations Basics
diff --git a/docs/source/contributing/testing.rst b/docs/source/contributing/testing.rst
index e4aeda2eb..4f6cdba72 100644
--- a/docs/source/contributing/testing.rst
+++ b/docs/source/contributing/testing.rst
@@ -3,7 +3,7 @@ Testing
Flake8
------
-RetroArcher uses `Flake8 `_ for enforcing consistent code styling. Flake is included
+RetroArcher uses `Flake8 `__ for enforcing consistent code styling. Flake is included
in the `requirements-dev.txt`.
The config file for flake8 is `.flake8`. This is already included in the root of the repo and should not be modified.
@@ -15,10 +15,10 @@ The config file for flake8 is `.flake8`. This is already included in the root of
Sphinx
------
-RetroArcher uses `Sphinx `_ for documentation building. Sphinx is included
+RetroArcher uses `Sphinx `__ for documentation building. Sphinx is included
in the standard `requirements.txt` as building the docs is required for RetroArcher to be fully functional.
-RetroArcher follows `numpydoc `_ styling and formatting in
+RetroArcher follows `numpydoc `__ styling and formatting in
docstrings. This will be tested when building the docs.
The config file for Sphinx is `docs/source/conf.py`. This is already included in the root of the repo and should not
@@ -39,7 +39,7 @@ be modified.
pytest
------
-RetroArcher uses `pytest `_ for unit testing. pytest is included in the
+RetroArcher uses `pytest `__ for unit testing. pytest is included in the
`requirements-dev.txt`.
No config is required for pytest.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index bd0ce5389..de6554f81 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,4 +1,4 @@
-LizardByte has this documentation hosted on `Read the Docs `_.
+LizardByte has this documentation hosted on `Read the Docs `__.
Table of Contents
=================
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 72970eb0a..c993a59db 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -2,3 +2,4 @@
flake8==6.0.0
pyinstaller==5.11.0
pytest==7.3.1
+rstcheck[sphinx]==6.2.0