Merge pull request #1764 from jwhitlock/update-docs

Update documentation
mozilla · Jan 11, 2022 · 8bcadb2 · 8bcadb2
2 parents 082156a + 1aa2a0c
commit 8bcadb2
Show file tree

Hide file tree

Showing 8 changed files with 199 additions and 104 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -2,9 +2,13 @@
 Changelog
 =========
 
-After August, 2017, see `releases page
-<https://github.com/mozilla/ichnaea/releases>`_ for releases and notes.
+See the
+`tags page <https://github.com/mozilla/ichnaea/tags>`_
+for releases after November 2019.
 
+See the
+`releases page <https://github.com/mozilla/ichnaea/releases>`_
+for releases from August 2017 to August 2019.
 
 2.2.0 (2017-08-23)
 ==================

diff --git a/docker/run_web.sh b/docker/run_web.sh
@@ -9,8 +9,7 @@ set -e
 # Port for gunicorn to listen on
 GUNICORN_PORT=${GUNICORN_PORT:-"8000"}
 
-# Number of gunicorn workers to spin off--should be one per
-# cpu
+# Number of gunicorn workers to spin off--should be one per cpu
 GUNICORN_WORKERS=${GUNICORN_WORKERS:-"1"}
 
 # Gunicorn worker class--use our gevent worker

diff --git a/docs/conf.py b/docs/conf.py
@@ -15,12 +15,12 @@
 
 
 project = "Ichnaea"
-copyright = "2013-2020, Mozilla"
+copyright = "2013-2022, Mozilla"
 
 # The short X.Y version.
-version = "2.0"
+version = "2.3"
 # The full version, including alpha/beta/rc tags.
-release = "2.0"
+release = "2.3"
 
 autoclass_content = "class"
 exclude_patterns = ["_build", ".DS_Store", "Thumbs.db"]

diff --git a/docs/configure.rst b/docs/configure.rst
@@ -12,10 +12,12 @@ inside database tables.
    :local:
 
 
+.. _environment-variables:
+
 Environment variables
 =====================
 
-.. autocomponent:: ichnaea.conf.AppConfig
+.. autocomponent:: ichnaea.conf.AppComponent
    :hide-classname:
    :case: upper
 

diff --git a/docs/deploy.png b/docs/deploy.png