ci: fix readthedocs build

.readthedocs.yaml

@@ -11,6 +11,12 @@ build:
   os: ubuntu-20.04
   tools:
     python: "2.7"
+  jobs:
+    pre_build:
+      - python ./scripts/build_plist.py
+    post_build:
+      - rstcheck -r .  # lint rst files
+      # - rstfmt --check --diff -w 120 .  # check rst formatting
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
@@ -25,4 +31,3 @@ python:
   install:
     - requirements: requirements.txt  # plugin requirements
     - requirements: requirements-dev.txt  # docs requirements
-  system_packages: true

.rstcheck.cfg

@@ -0,0 +1,11 @@
+# configuration file for rstcheck, an rst linting tool
+# https://rstcheck.readthedocs.io/en/latest/usage/config
+
+[rstcheck]
+ignore_directives =
+    automodule,
+    include,
+    mdinclude,
+    todo,
+ignore_roles =
+    modname,

README.rst

@@ -2,7 +2,7 @@
 
 Overview
 ========
-LizardByte has the full documentation hosted on `Read the Docs <http://plexyglass.readthedocs.io/>`_.
+LizardByte has the full documentation hosted on `Read the Docs <http://plexyglass.readthedocs.io/>`__.
 
 About
 -----

docs/source/about/installation.rst

@@ -12,7 +12,7 @@ The bundle is cross platform, meaning Linux, macOS, and Windows are supported.
 #. Extract the contents to your Plex Media Server Plugins directory.
 
 .. Tip:: See
-   `How do I find the Plug-Ins folder <https://support.plex.tv/articles/201106098-how-do-i-find-the-plug-ins-folder>`_
+   `How do I find the Plug-Ins folder <https://support.plex.tv/articles/201106098-how-do-i-find-the-plug-ins-folder>`__
    for information specific to your Plex server install.
 
 Docker

docs/source/about/usage.rst

@@ -37,4 +37,4 @@ minimal example.
    metadata.extras.add(OtherObject(url=video_url))
 
 .. Tip:: For help with metadata agent or general plug-in development, check out our
-   `plexhints <https://app.lizardbyte.dev/#Projects>`_ python library.
+   `plexhints <https://app.lizardbyte.dev/#Projects>`__ python library.

docs/source/contributing/build.rst

@@ -7,7 +7,7 @@ Python 2.7.
 
 Clone
 -----
-Ensure `git <https://git-scm.com/>`_ is installed and run the following:
+Ensure `git <https://git-scm.com/>`__ is installed and run the following:
 
    .. code-block:: bash
 

docs/source/contributing/contributing.rst

@@ -4,4 +4,4 @@ Contributing
 ============
 
 Read our contribution guide in our organization level
-`docs <https://lizardbyte.readthedocs.io/en/latest/developers/contributing.html>`_.
+`docs <https://lizardbyte.readthedocs.io/en/latest/developers/contributing.html>`__.

docs/source/contributing/testing.rst

@@ -5,7 +5,7 @@ Testing
 
 Flake8
 ------
-PlexyGlass uses `Flake8 <https://pypi.org/project/flake8/>`_ for enforcing consistent code styling. Flake is included
+PlexyGlass uses `Flake8 <https://pypi.org/project/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.
@@ -17,10 +17,10 @@ Test with Flake8
 
 Sphinx
 ------
-PlexyGlass uses `Sphinx <https://www.sphinx-doc.org/en/master/>`_ for documentation building. Sphinx is included
+PlexyGlass uses `Sphinx <https://www.sphinx-doc.org/en/master/>`__ for documentation building. Sphinx is included
 in the ``requirements-dev.txt``.
 
-PlexyGlass follows `numpydoc <https://numpydoc.readthedocs.io/en/latest/format.html>`_ styling and formatting in
+PlexyGlass follows `numpydoc <https://numpydoc.readthedocs.io/en/latest/format.html>`__ styling and formatting in
 docstrings. This will be tested when building the docs. `numpydoc` is included in the ``requirements-dev.txt``.
 
 The config file for Sphinx is ``docs/source/conf.py``. This is already included in the root of the repo and should not
@@ -43,7 +43,7 @@ pytest
 ------
 .. Todo:: PyTest is not yet implemented.
 
-PlexyGlass uses `pytest <https://pypi.org/project/pytest/>`_ for unit testing. pytest is included in the
+PlexyGlass uses `pytest <https://pypi.org/project/pytest/>`__ for unit testing. pytest is included in the
 ``requirements-dev.txt``.
 
 No config is required for pytest.

requirements-dev.txt

@@ -5,5 +5,6 @@ numpydoc==0.9.2;python_version<"3"
 pathlib2==2.3.7.post1;python_version<"3"
 git+https://github.com/LizardByte/plexhints.git#egg=plexhints  # type hinting library for plex development
 pytest==4.6.11;python_version<"3"
+rstcheck==3.5.0;python_version<"3"
 Sphinx==1.8.6;python_version<"3"
 sphinx-rtd-theme==1.1.1;python_version<"3"