Proper venv. Enable sphinxcontrib-email.

lockss · Mar 9, 2022 · 2ba9b47 · 2ba9b47
1 parent d9c41d9
commit 2ba9b47
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
+/.venv
 /.project
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,9 +33,16 @@
 extensions = [
     # See https://github.com/readthedocs/sphinx_rtd_theme
     'sphinx_rtd_theme',
+
+    # See https://www.sphinx-doc.org/en/master/usage/extensions/index.html
     'sphinx.ext.autosectionlabel',
     'sphinx.ext.intersphinx',
+
+    # See https://github.com/executablebooks/sphinx-tabs
     'sphinx_tabs.tabs',
+
+    # See https://github.com/sphinx-contrib/email
+    'sphinxcontrib.email',
 ]
 
 intersphinx_mapping = {

diff --git a/docs/index.rst b/docs/index.rst
@@ -106,7 +106,7 @@ LOCKSS 2.0-alpha5 System Manual
    Contact Us
    ----------
 
-   Please contact us for questions, feedback and bug reports. Open a ticket by sending e-mail to ``lockss-support (at) lockss (dot) org``. Your contribution toward the final LOCKSS 2.0 release is very important to us and greatly appreciated by the community.
+   Please contact us for questions, feedback and bug reports. Open a ticket by sending e-mail to :email:`lockss-support@lockss.org`. Your contribution toward the final LOCKSS 2.0 release is very important to us and greatly appreciated by the community.
 
 .. toctree::
    :caption: LOCKSS 2.0-alpha5 System Manual

diff --git a/docs/installing/installer.rst b/docs/installing/installer.rst
@@ -563,7 +563,7 @@ During this phase, :program:`install-lockss` runs a series of tests to verify th
 
       You can also alter the number of retries and the number of seconds between retries with :samp:`--retries={N}` and :samp:`--wait={S}` respectively.
 
-      Other problems may require reaching out to the LOCKSS support team at ``lockss-support (at) lockss (dot) org`` for assistance.
+      Other problems may require reaching out to the LOCKSS support team at :email:`lockss-support@lockss.org` for assistance.
 
 3. Finally, you will see the message:
 

diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,4 @@
+sphinx
+sphinx-rtd-theme
 sphinx-tabs
+sphinxcontrib-email