Add requirements.txt for documentation, fix extlinks

RTD now installs many fewer packages by default for documentation builds and the user must specify the packages they need (and the desired versions, if necessary). Fix extlinks interpreted link configuration to match current Sphinx requirements. Specify language for documentation accessibility.

.readthedocs.yaml

@@ -29,9 +29,11 @@ formats:
    - epub
    - htmlzip
 
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
+# Declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+# Not strictly required, but default builds were updated to
+# include very few packages
+# See: https://blog.readthedocs.com/defaulting-latest-build-tools/
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -57,7 +57,7 @@
 
 # General information about the project.
 project = 'Scout'
-copyright = '2018'
+copyright = '2023'
 author = 'Chioke Harris and Jared Langevin'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -74,7 +74,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -404,9 +404,9 @@ def _warn_node(self, msg, node, **kwargs):
 
 # Define custom external link references
 extlinks = {'repo_file': ('https://github.com/trynthink/scout/blob/master/%s',
-                          ''),
+                          '%s'),
             'issue': ('https://github.com/trynthink/scout/issues/%s',
-                      'issue ')}
+                      'issue %s')}
 # These can be used with the syntax (for example):
 # :issue:`123` to reference produce "issue 123" with a hyperlink in the text
 # :issue:`custom text <123>` to produce "custom text" with a hyperlink

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx_rtd_theme
+readthedocs-sphinx-search