Use prj name and supported Py in docs via substs

webknjaz · webknjaz · commit 1f6b044242ed · 2018-01-13T02:44:40.000+02:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -54,6 +54,12 @@ def get_supported_pythons(classifiers):
     lambda v: '.'.join(v), prj_py_ver_range
 )
 
+rst_epilog = f"""
+.. |project| replace:: CherryPy
+.. |min_py_supported| replace:: {prj_py_min_supported}
+.. |max_py_supported| replace:: {prj_py_max_supported}
+"""
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
diff --git a/docs/install.rst b/docs/install.rst
@@ -2,7 +2,7 @@
 Installation
 ------------
 
-CherryPy is a pure Python library. This has various consequences:
+|project| is a pure Python library. This has various consequences:
 
  - It can run anywhere Python runs
  - It does not require a C compiler
@@ -15,9 +15,9 @@ CherryPy is a pure Python library. This has various consequences:
 Requirements
 ############
 
-CherryPy does not have any mandatory requirements. However certain features it comes with
+|project| does not have any mandatory requirements. However certain features it comes with
 will require you install certain packages. To simplify installing additional
-dependencies CherryPy enables you to specify extras in your requirements (e.g.
+dependencies |project| enables you to specify extras in your requirements (e.g.
 ``cherrypy[json,routes_dispatcher,ssl]``):
 
 - doc -- for documentation related stuff
@@ -32,13 +32,13 @@ dependencies CherryPy enables you to specify extras in your requirements (e.g.
 Supported python version
 ########################
 
-CherryPy supports Python 2.7 through to 3.5.
+|project| supports Python |min_py_supported| through to |max_py_supported|.
 
 
 Installing
 ##########
 
-CherryPy can be easily installed via common Python package managers such as setuptools or pip.
+|project| can be easily installed via common Python package managers such as setuptools or pip.
 
 .. code-block:: bash
 
@@ -49,7 +49,7 @@ CherryPy can be easily installed via common Python package managers such as setu
 
    $ pip install cherrypy
 
-You may also get the latest CherryPy version by grabbing the source code from Github:
+You may also get the latest |project| version by grabbing the source code from Github:
 
 .. code-block:: bash
 
@@ -60,7 +60,7 @@ You may also get the latest CherryPy version by grabbing the source code from Gi
 Test your installation
 ^^^^^^^^^^^^^^^^^^^^^^
 
-CherryPy comes with a set of simple tutorials that can be executed
+|project| comes with a set of simple tutorials that can be executed
 once you have deployed the package.
 
 .. code-block:: bash
@@ -102,7 +102,7 @@ cherryd
 ^^^^^^^
 
 Another way to run the application is through the ``cherryd`` script
-which is installed along side CherryPy.
+which is installed along side |project|.
 
 .. note::
 
