Read the Docs build information
Build id: 786949
Project: institute-for-disease-modeling-doc-guidance
Version: latest
Commit: 73a381a24d8b1108a97c6bc0177b6940f61bc7e2
Date: 2021-12-01T00:17:47.149194Z
State: finished
Success: True


[rtd-command-info] start-time: 2021-12-01T00:17:54.928920Z, end-time: 2021-12-01T00:17:57.986925Z, duration: 3, exit-code: 0
git clone --no-single-branch --depth 50 git@github.com:InstituteforDiseaseModeling/doc-guidance.git .
Cloning into '.'...
Warning: Permanently added 'github.com,192.30.255.113' (ECDSA) to the list of known hosts.

[rtd-command-info] start-time: 2021-12-01T00:17:58.153410Z, end-time: 2021-12-01T00:17:58.248504Z, duration: 0, exit-code: 0
git checkout --force origin/main
Note: checking out 'origin/main'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another checkout.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -b with the checkout command again. Example:

  git checkout -b <new-branch-name>

HEAD is now at 73a381a Merge pull request #17 from JSchripsema-IDM/public-version

[rtd-command-info] start-time: 2021-12-01T00:17:58.365879Z, end-time: 2021-12-01T00:17:58.432184Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2021-12-01T00:17:59.558334Z, end-time: 2021-12-01T00:18:14.208402Z, duration: 14, exit-code: 0
python3.7 -mvirtualenv 
Using base prefix '/home/docs/.pyenv/versions/3.7.9'
New python executable in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/bin/python3.7
Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/bin/python
Installing setuptools, pip, wheel...
done.

[rtd-command-info] start-time: 2021-12-01T00:18:14.320566Z, end-time: 2021-12-01T00:18:15.703964Z, duration: 1, exit-code: 0
python -m pip install --upgrade --no-cache-dir pip setuptools
Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (21.3.1)
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (59.4.0)

[rtd-command-info] start-time: 2021-12-01T00:18:15.820442Z, end-time: 2021-12-01T00:18:24.660253Z, duration: 8, exit-code: 0
python -m pip install --upgrade --no-cache-dir mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.2
Collecting mock==1.0.1
  Downloading mock-1.0.1.zip (861 kB)
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting pillow==5.4.1
  Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB)
Collecting alabaster!=0.7.5,<0.8,>=0.7
  Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB)
Collecting commonmark==0.8.1
  Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB)
Collecting recommonmark==0.5.0
  Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB)
Collecting sphinx
  Downloading Sphinx-4.3.1-py3-none-any.whl (3.1 MB)
Collecting sphinx-rtd-theme
  Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB)
Collecting readthedocs-sphinx-ext<2.2
  Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB)
Collecting future
  Downloading future-0.18.2.tar.gz (829 kB)
  Preparing metadata (setup.py): started
  Preparing metadata (setup.py): finished with status 'done'
Collecting docutils>=0.11
  Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB)
Collecting Pygments>=2.0
  Downloading Pygments-2.10.0-py3-none-any.whl (1.0 MB)
Collecting imagesize
  Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB)
Collecting snowballstemmer>=1.1
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
Collecting sphinxcontrib-applehelp
  Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB)
Collecting sphinxcontrib-devhelp
  Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.5
  Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB)
Collecting docutils>=0.11
  Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB)
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx) (59.4.0)
Collecting sphinxcontrib-qthelp
  Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB)
Collecting babel>=1.3
  Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB)
Collecting requests>=2.5.0
  Downloading requests-2.26.0-py2.py3-none-any.whl (62 kB)
Collecting sphinxcontrib-jsmath
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Collecting Jinja2>=2.3
  Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0
  Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB)
Collecting packaging
  Downloading packaging-21.3-py3-none-any.whl (40 kB)
Collecting pytz>=2015.7
  Downloading pytz-2021.3-py2.py3-none-any.whl (503 kB)
Collecting MarkupSafe>=2.0
  Downloading MarkupSafe-2.0.1-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (31 kB)
Collecting urllib3<1.27,>=1.21.1
  Downloading urllib3-1.26.7-py2.py3-none-any.whl (138 kB)
Collecting charset-normalizer~=2.0.0
  Downloading charset_normalizer-2.0.8-py3-none-any.whl (39 kB)
Collecting certifi>=2017.4.17
  Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB)
Collecting idna<4,>=2.5
  Downloading idna-3.3-py3-none-any.whl (61 kB)
Collecting pyparsing!=3.0.5,>=2.0.2
  Downloading pyparsing-3.0.6-py3-none-any.whl (97 kB)
Building wheels for collected packages: mock, future
  Building wheel for mock (setup.py): started
  Building wheel for mock (setup.py): finished with status 'done'
  Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=4c763fa82113a2aa0cf5673078eb87a7129665600fb26136c871099e18966c17
  Stored in directory: /tmp/pip-ephem-wheel-cache-iyaqa7kd/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1
  Building wheel for future (setup.py): started
  Building wheel for future (setup.py): finished with status 'done'
  Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=44c9200b86a7594d485c4c8f7e17be4e41776662c0ca28e7e2566706798abcc6
  Stored in directory: /tmp/pip-ephem-wheel-cache-iyaqa7kd/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0
Successfully built mock future
Installing collected packages: urllib3, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock
Successfully installed Jinja2-3.0.3 MarkupSafe-2.0.1 Pygments-2.10.0 alabaster-0.7.12 babel-2.9.1 certifi-2021.10.8 charset-normalizer-2.0.8 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-3.3 imagesize-1.3.0 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.6 pytz-2021.3 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.26.0 snowballstemmer-2.2.0 sphinx-4.3.1 sphinx-rtd-theme-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-1.26.7

[rtd-command-info] start-time: 2021-12-01T00:18:24.771891Z, end-time: 2021-12-01T00:18:29.702908Z, duration: 4, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
Collecting plantweb~=1.2.1
  Downloading plantweb-1.2.1-py3-none-any.whl (20 kB)
Collecting pygit2~=1.4.0
  Downloading pygit2-1.4.0-cp37-cp37m-manylinux2010_x86_64.whl (3.0 MB)
Collecting PyGithub~=1.53
  Downloading PyGithub-1.55-py3-none-any.whl (291 kB)
Collecting sphinx-copybutton~=0.3.1
  Downloading sphinx_copybutton-0.3.3-py3-none-any.whl (12 kB)
Collecting sphinx-rtd-theme~=0.5.0
  Downloading sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl (9.1 MB)
Collecting sphinxcontrib-napoleon~=0.7
  Downloading sphinxcontrib_napoleon-0.7-py2.py3-none-any.whl (17 kB)
Collecting sphinxcontrib-programoutput~=0.16
  Downloading sphinxcontrib_programoutput-0.17-py2.py3-none-any.whl (22 kB)
Collecting sphinx~=3.3.1
  Downloading Sphinx-3.3.1-py3-none-any.whl (2.9 MB)
Collecting sphinxext.remoteliteralinclude
  Downloading sphinxext_remoteliteralinclude-0.3.0-py3-none-any.whl (6.3 kB)
Requirement already satisfied: requests in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (2.26.0)
Collecting six
  Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (0.17.1)
Collecting cached-property
  Downloading cached_property-1.5.2-py2.py3-none-any.whl (7.6 kB)
Collecting cffi>=1.4.0
  Downloading cffi-1.15.0-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (427 kB)
Collecting pyjwt>=2.0
  Downloading PyJWT-2.3.0-py3-none-any.whl (16 kB)
Collecting deprecated
  Downloading Deprecated-1.2.13-py2.py3-none-any.whl (9.6 kB)
Collecting pynacl>=1.4.0
  Downloading PyNaCl-1.4.0-cp35-abi3-manylinux1_x86_64.whl (961 kB)
Collecting docutils
  Downloading docutils-0.16-py2.py3-none-any.whl (548 kB)
Collecting pockets>=0.3
  Downloading pockets-0.9.1-py2.py3-none-any.whl (26 kB)
Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2.9.1)
Requirement already satisfied: sphinxcontrib-htmlhelp in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.1.5)
Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (3.0.3)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.0.1)
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (21.3)
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (59.4.0)
Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2.2.0)
Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.3.0)
Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2.10.0)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.0.3)
Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (0.7.12)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.0.2)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (1.0.2)
Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from babel>=1.3->sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2021.3)
Collecting pycparser
  Downloading pycparser-2.21-py2.py3-none-any.whl (118 kB)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (2.0.1)
Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from requests->plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (1.26.7)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from requests->plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (3.3)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from requests->plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (2021.10.8)
Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from requests->plantweb~=1.2.1->-r docs/requirements.txt (line 1)) (2.0.8)
Collecting wrapt<2,>=1.10
  Downloading wrapt-1.13.3-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (79 kB)
Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-doc-guidance/envs/latest/lib/python3.7/site-packages (from packaging->sphinx~=3.3.1->-r docs/requirements.txt (line 8)) (3.0.6)
Installing collected packages: pycparser, wrapt, six, docutils, cffi, sphinx, pynacl, pyjwt, pockets, deprecated, cached-property, sphinxext.remoteliteralinclude, sphinxcontrib-programoutput, sphinxcontrib-napoleon, sphinx-rtd-theme, sphinx-copybutton, PyGithub, pygit2, plantweb
  Attempting uninstall: docutils
    Found existing installation: docutils 0.17.1
    Uninstalling docutils-0.17.1:
      Successfully uninstalled docutils-0.17.1
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 4.3.1
    Uninstalling Sphinx-4.3.1:
      Successfully uninstalled Sphinx-4.3.1
  Attempting uninstall: sphinx-rtd-theme
    Found existing installation: sphinx-rtd-theme 1.0.0
    Uninstalling sphinx-rtd-theme-1.0.0:
      Successfully uninstalled sphinx-rtd-theme-1.0.0
Successfully installed PyGithub-1.55 cached-property-1.5.2 cffi-1.15.0 deprecated-1.2.13 docutils-0.16 plantweb-1.2.1 pockets-0.9.1 pycparser-2.21 pygit2-1.4.0 pyjwt-2.3.0 pynacl-1.4.0 six-1.16.0 sphinx-3.3.1 sphinx-copybutton-0.3.3 sphinx-rtd-theme-0.5.2 sphinxcontrib-napoleon-0.7 sphinxcontrib-programoutput-0.17 sphinxext.remoteliteralinclude-0.3.0 wrapt-1.13.3

[rtd-command-info] start-time: 2021-12-01T00:18:30.778533Z, end-time: 2021-12-01T00:18:30.844077Z, duration: 0, exit-code: 0
cat docs/conf.py
# -*- coding: utf-8 -*-
#
# Sphinx Demo docs build configuration file, created by
# sphinx-quickstart on Fri Aug 26 16:52:16 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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
# docs root, use os.path.abspath to make it absolute, like shown here.
#
import configparser
import os
import subprocess
import sys

import sphinx_rtd_theme
from datetime import datetime

# -- General configuration ------------------------------------------------

# If your docs needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.imgmath',
    'sphinx.ext.githubpages',
    'sphinx.ext.autodoc',
    'sphinxcontrib.napoleon',
    'sphinx.ext.todo',
    'plantweb.directive',
    'sphinxcontrib.programoutput',
    'sphinx_copybutton',
    'sphinxext.remoteliteralinclude',
    'sphinx.ext.intersphinx'
]

plantuml = 'plantweb'

autodoc_default_options = {
    'member-order': 'bysource',
    'members': None,
    'exclude-members': '__all__'
}

autodoc_mock_imports = []


napoleon_google_docstring = True
# napoleon_numpy_docstring = True

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The encoding of source files.
#
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Doc guidance'
copyright = f'1999 - {datetime.today().year}, Bill & Melinda Gates Foundation. All rights reserved'
author = u'Institute for Disease Modeling'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.

# version = ''
# The full version, including alpha/beta/rc tags.
# release = u'1.0'

# The language for content autogenerated by Sphinx. Refer to docs
# for a list of supported languages.
#
# 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

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'templates']

# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

# RST epilog is added to the end of every topic. Useful for replace
# directives to use across the docset.

rst_epilog = "\n.. include:: /reuse/variables.txt"

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the docs for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# docs.
# #
# html_theme_options = {
# }

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents.
# "<project> v<release> docs" by default.
#
# html_title = u'Sphinx Demo v1.0'

# A shorter title for the navigation bar.  Default is the same as html_title.
#
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
html_logo = "images/IDM_white.png"

# The name of an image file (relative to this directory) to use as a favicon of
# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
html_favicon = "images/favicon.ico"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_context = {
    'css_files': [
        '_static/theme_overrides.css',
        '_static/copy_button.css'
    ]
}
html_js_files = ['show_block_by_os.js']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the docs.
#
# html_extra_path = []

# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}

# If false, no module index is generated.
#
# html_domain_indices = True

# If false, no index is generated.
#
# html_use_index = True

# If true, the index is split into individual pages for each letter.
#
# html_split_index = False

# If true, links to the reST sources are added to the pages.
#
html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
html_show_sphinx = False

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#
html_use_opensearch = 'www.idmod.org/docs/'

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'

# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}

# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'

# Output file base name for HTML help builder.
htmlhelp_basename = 'Style guide'

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
    (master_doc, 'style-docs.tex', u'Style guide',
     u'Institute for Disease Modeling', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#
# latex_use_parts = False

# If true, show page references after internal links.
#
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
#
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
#
# latex_appendices = []

# It false, will not define \strong, \code,     itleref, \crossref ... but only
# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
# packages.
#
# latex_keep_old_macro_names = True

# If false, no module index is generated.
#
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, 'style-docs', u'Style guide',
     [author], 1)
]

# If true, show URL addresses after external links.
#
man_show_urls = True

# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    (master_doc, 'style-docs', u'Style guide',
     author, 'Institute for Disease Modeling', 'Style guide and guidelines for writing documentation at IDM.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []

# If false, no module index is generated.
#
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
                       'emod-generic': ('https://docs.idmod.org/projects/emod-generic/en/latest/', None)
                       }




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
# Note: this file shouldn't rely on extra dependencies.

import importlib
import sys
import os.path

# Borrowed from six.
PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Add RTD Theme only if they aren't overriding it already
using_rtd_theme = (
    (
        'html_theme' in globals() and
        html_theme in ['default'] and
        # Allow people to bail with a hack of having an html_style
        'html_style' not in globals()
    ) or 'html_theme' not in globals()
)
if using_rtd_theme:
    theme = importlib.import_module('sphinx_rtd_theme')
    html_theme = 'sphinx_rtd_theme'
    html_style = None
    html_theme_options = {}
    if 'html_theme_path' in globals():
        html_theme_path.append(theme.get_html_theme_path())
    else:
        html_theme_path = [theme.get_html_theme_path()]

if globals().get('websupport2_base_url', False):
    websupport2_base_url = 'https://readthedocs.com/websupport'
    websupport2_static_url = 'https://assets.readthedocs.com/'


#Add project information to the template context.
context = {
    'using_theme': using_rtd_theme,
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.com/media/",
    'STATIC_URL': "https://assets.readthedocs.com/",
    'PRODUCTION_DOMAIN': "readthedocs.com",
    'versions': [
    ("latest", "/en/latest/"),
    ],
    'downloads': [ 
    ("html", "//docs.idmod.org/_/downloads/doc-guidance/en/latest/htmlzip/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'institute-for-disease-modeling-doc-guidance',
    'name': u'doc-guidance',
    'rtd_language': u'en',
    'programming_language': u'words',
    'canonical_url': 'https://docs.idmod.org/projects/doc-guidance/en/latest/',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/',
    'api_host': 'https://readthedocs.com',
    'github_user': 'InstituteforDiseaseModeling',
    'proxied_api_host': '/_',
    'github_repo': 'doc-guidance',
    'github_version': 'main',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'main',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'main',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-2',
    'commit': '73a381a2',
}

# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





if 'html_context' in globals():
    
    html_context.update(context)
    
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.com/projects/institute-for-disease-modeling-doc-guidance/builds/786949/'

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])

[rtd-command-info] start-time: 2021-12-01T00:18:30.993232Z, end-time: 2021-12-01T00:18:34.031176Z, duration: 3, exit-code: 0
python -m sphinx -T -E -W --keep-going -b html -d _build/doctrees -D language=en . _build/html
Running Sphinx v3.3.1
loading translations [en]... done
making output directory... done
loading intersphinx inventory from https://docs.python.org/3/objects.inv...
loading intersphinx inventory from https://docs.idmod.org/projects/emod-generic/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 16 source files that are out of date
updating environment: [new config] 16 added, 0 changed, 0 removed
reading sources... [  6%] docstrings
reading sources... [ 12%] editors
reading sources... [ 18%] emod-docs
reading sources... [ 25%] faq
reading sources... [ 31%] getting-started
reading sources... [ 37%] github
reading sources... [ 43%] index
reading sources... [ 50%] paramdb
reading sources... [ 56%] rst
reading sources... [ 62%] rtd
reading sources... [ 68%] sphinx
reading sources... [ 75%] sphinx-config
reading sources... [ 81%] sphinx-troubleshooting
reading sources... [ 87%] style-guide
reading sources... [ 93%] templates
reading sources... [100%] toolchain

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [  6%] docstrings
writing output... [ 12%] editors
writing output... [ 18%] emod-docs
writing output... [ 25%] faq
writing output... [ 31%] getting-started
writing output... [ 37%] github
writing output... [ 43%] index
writing output... [ 50%] paramdb
writing output... [ 56%] rst
writing output... [ 62%] rtd
writing output... [ 68%] sphinx
writing output... [ 75%] sphinx-config
writing output... [ 81%] sphinx-troubleshooting
writing output... [ 87%] style-guide
writing output... [ 93%] templates
writing output... [100%] toolchain

generating indices... genindex done
writing additional pages... search opensearch done
copying images... [ 11%] images/pycharm-1.png
copying images... [ 22%] images/pycharm-2.png
copying images... [ 33%] images/pycharm-3.png
copying images... [ 44%] _build/html/_images/plantweb/a12b066ace0fd18c911e96078e39e8cf3ba5ee1026c499bb93d273e71fdd25e9.svg
copying images... [ 55%] _build/html/_images/plantweb/0af3cfe073d89750c39dff538f0b5de3c116d4440e3118712afaedabe6194b47.svg
copying images... [ 66%] _build/html/_images/plantweb/a2e9c9ecdf886f6ca54e2fd89435bf5fcb0f490acdcbd9d0dccbd544adbd8fad.svg
copying images... [ 77%] _build/html/_images/plantweb/3890485a81c5c1ee4509b2fecde3c35770a56b4bae777de2f1bf4190101e9bda.svg
copying images... [ 88%] images/edit-on-gh.png
copying images... [100%] images/Toolchain.png

copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
Updating searchtools for Read the Docs search...

[rtd-command-info] start-time: 2021-12-01T00:18:34.180268Z, end-time: 2021-12-01T00:18:35.230322Z, duration: 1, exit-code: 0
python -m sphinx -T -W --keep-going -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . _build/localmedia
Running Sphinx v3.3.1
loading translations [en]... done
making output directory... done
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [readthedocssinglehtmllocalmedia]: all documents
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
preparing documents... done
assembling single document... getting-started rst templates docstrings emod-docs toolchain editors paramdb github sphinx sphinx-config sphinx-troubleshooting rtd style-guide faq done
writing... done
writing additional files...  opensearchdone
copying images... [ 11%] _build/html/_images/plantweb/a12b066ace0fd18c911e96078e39e8cf3ba5ee1026c499bb93d273e71fdd25e9.svg
copying images... [ 22%] _build/html/_images/plantweb/0af3cfe073d89750c39dff538f0b5de3c116d4440e3118712afaedabe6194b47.svg
copying images... [ 33%] _build/html/_images/plantweb/a2e9c9ecdf886f6ca54e2fd89435bf5fcb0f490acdcbd9d0dccbd544adbd8fad.svg
copying images... [ 44%] _build/html/_images/plantweb/3890485a81c5c1ee4509b2fecde3c35770a56b4bae777de2f1bf4190101e9bda.svg
copying images... [ 55%] images/edit-on-gh.png
copying images... [ 66%] images/Toolchain.png
copying images... [ 77%] images/pycharm-1.png
copying images... [ 88%] images/pycharm-2.png
copying images... [100%] images/pycharm-3.png

copying static files... done
copying extra files... done
dumping object inventory... done
build succeeded.

The HTML page is in _build/localmedia.
Updating searchtools for Read the Docs search...