fix documentation version generation

Author: gilesknap

Pipfile

@@ -4,31 +4,13 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-# Pinning black stops us having to allow pre-releases globally
-black = "==19.10b0"
-# Pins to make lockfile usable on multiple Python versions and platforms
-mypy = "*"
-atomicwrites = "*"
-typing-extensions = "*"
-importlib-metadata = "*"
-# List wheel here to make sure we make the same version to make wheels on gitlab and github CI
-wheel = "0.33.1"
-# Test and docs dependencies
-pytest-cov = "*"
-pytest-mypy = "*"
-pytest-flake8 = "*"
-pytest-black = "*"
-flake8-isort = "*"
-isort = ">5.0"
-sphinx-rtd-theme = "*"
+softioc = {editable = true, extras = ["dev"], path = "."}
 
 [packages]
-# All other package requirements from setup.cfg
-epics_containers = {path = "."}
+softioc = {editable = true, extras = ["useful"], path = "."}
 
 [scripts]
-tests = "python -m pytest"
+# Do flake8 here so it doesn't happen in the container in CI
+tests = "python -m pytest --flake8"
 docs = "sphinx-build -EWT --keep-going docs build/html"
-build = "python setup.py sdist bdist_wheel"
-# Delete any files that git ignore hides from us
-gitclean = "git clean -fdX"
+gitclean = "git clean -fdX"

Pipfile.lock

@@ -26,6 +26,14 @@ Organization   https://github.com/epics-containers
     :alt: Apache License
 
 
+Materials
+=========
+
+The following links are to materials presented at the ICALEPCS 2021 Meeting:
+
+  - :download:`ICALEPCS 2021 Paper: Kubernetes for EPICS IOCs<images/THBL04.PDF>`
+  - :download:`ICALEPCS 2021 Talk: Kubernetes for EPICS IOCs<images/THBL04_talk.PDF>`
+
 Overview
 ========
 
@@ -39,11 +47,6 @@ management of IOCs.
 - CI / CD generates the images, charts from source and delivers them
   to **Repositories**
 
-The following links are to materials presented at the ICALEPCS 2021 Meeting:
-
-  - :download:`ICALEPCS 2021 Paper: Kubernetes for EPICS IOCs<images/THBL04.PDF>`
-  - :download:`ICALEPCS 2021 Talk: Kubernetes for EPICS IOCs<images/THBL04_talk.PDF>`
-
 Below we show how these assets combine to create a running IOC on a
 Kubernetes worker node.
 
@@ -68,6 +71,18 @@ Kubernetes worker node.
 
     - https://github.com/epics-containers/bl45p
 
+The Generic IOC container images are built using a hierarchy with the most
+common elements shared as shown in the following diagram:
+
+.. image:: images/image-hierarchy.png
+    :width: 350px
+    :align: center
+
+EPICS base and essential tools are compiled inside one image; the most commonly
+used support modules(primarily Asyn) and the AreaDetector framework
+also have their own images. Generic IOC images are then
+leaves in the hierarchy and are based upon the appropriate dependencies.
+
 ..
     Anything below this line is used when viewing README.rst and will be replaced
     when included in index.rst

README.rst

@@ -12,22 +12,17 @@
     padding: 4px 6px;
 }
 
-/* allow us to stop margin after list so we can add to it */
-.no-margin-after-ul ul {
-    margin-bottom: 0 !important;
-}
-
 /* Add two-column option */
-@media only screen and (min-width: 1000px),
-       only screen and (min-width: 500px) and (max-width: 768px){
+@media only screen and (min-width: 1000px) {
     .columns {
-        padding-left: 5px;
-        padding-right: 5px;
+        padding-left: 10px;
+        padding-right: 10px;
         float: left;
         width: 50%;
+        min-height: 145px;
     }
 }
 
 .endcolumns {
     clear: both
-}
+}

docs/_static/theme_overrides.css

@@ -104,12 +104,13 @@
     http://www.diamond.ac.uk
 """
 
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = "sphinx_rtd_theme"
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently "default" and "sphinxdoc".
+try:
+    import sphinx_rtd_theme_github_versions
+    html_theme = "sphinx_rtd_theme_github_versions"
+except ImportError:
+    html_theme = "default"
 
 # Options for the sphinx rtd theme
 html_theme_options = dict(style_nav_header_background="rgb(7, 43, 93)")

docs/_templates/layout.html

@@ -16,15 +16,19 @@ classifiers =
 
 [options]
 packages = find:
-# install_requires =
-#     numpy
-#     scipy
 
 # If you want to include data files in packages,
 # either define [options.package_data] or
 # set this to True and include a MANIFEST.in file.
 include_package_data = False
 
+[options.extras_require]
+# Dev and docs dependencies
+dev =
+    pytest-cov
+    pytest-flake8
+    sphinx-rtd-theme-github-versions; python_version > "3.0"
+
 [options.packages.find]
 # Don't include our tests directory in the distribution
 exclude = tests