Initial setup for developer docs build

Refs #21679

CMakeLists.txt

@@ -202,6 +202,24 @@ endif()
 
 add_subdirectory ( scripts )
 
+# Docs requirements
+find_package ( Sphinx 1.2 )
+if ( SPHINX_FOUND )
+  # run python to see if the theme is installed
+  execute_process ( COMMAND ${PYTHON_EXECUTABLE} -c "import sphinx_bootstrap_theme"
+                    OUTPUT_VARIABLE SPHINX_BOOTSTRAP_THEME_OUT
+                    ERROR_VARIABLE SPHINX_BOOTSTRAP_THEME_ERR
+                    OUTPUT_STRIP_TRAILING_WHITESPACE
+                    ERROR_STRIP_TRAILING_WHITESPACE )
+  if (SPHINX_BOOTSTRAP_THEME_ERR)
+    message (ERROR " Did not find sphinx_bootstrap_theme")
+    message (STATUS "${PYTHON_EXECUTABLE} -c \"import sphinx_bootstrap_theme\"")
+    message (STATUS "${SPHINX_BOOTSTRAP_THEME_ERR}")
+    message (FATAL_ERROR " Install instructions at https://pypi.python.org/pypi/sphinx-bootstrap-theme/")
+  endif ()
+endif ()
+
+add_subdirectory ( dev-docs )
 if ( ENABLE_MANTIDPLOT )
   add_subdirectory ( docs )
 endif()

dev-docs/CMakeLists.txt

+###############################################################################
+# Developer documentation
+###############################################################################
+# targets
+set ( BUILDER html )
+set ( OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/${BUILDER} )
+set ( DOCTREE_DIR ${CMAKE_CURRENT_BINARY_DIR}/doctree )
+
+add_custom_target ( dev-docs-${BUILDER}
+                   COMMAND python -m sphinx -b ${BUILDER} -d ${DOCTREE_DIR} ${CMAKE_CURRENT_LIST_DIR}/source ${OUT_DIR}
+                   COMMENT "Building html developer documentation" )
+# Group within VS and exclude from whole build
+set_target_properties ( dev-docs-html PROPERTIES FOLDER "Documentation"
+                       EXCLUDE_FROM_DEFAULT_BUILD 1
+                       EXCLUDE_FROM_ALL 1 )

dev-docs/source/GettingStarted.rst

+===========================
+Getting Started with Mantid
+===========================
+
+.. contents::
+  :local:
+
+Prerequisites
+#############
+
+Some intial setup is required before being able to build the code. This is platform
+specific and described here.
+
+Windows
+-------
+
+Install the following:
+
+* `Visual Studio 2015 Community Edition <https://go.microsoft.com/fwlink/?LinkId=532606&clcid=0x409>`_. If you are at RAL then
+  ask for the location of the locally-cached offline version.
+* `Git <https://git-scm.com/download/win>`_
+* `Git LFS <https://git-lfs.github.com/>`_
+
+  * After installation open Git Bash and run ``git lfs install``
+
+* `CMake <https://cmake.org/download/>`_
+* `MiKTeX <https://miktex.org/download>`_. Instructions are available
+  `here <https://miktex.org/howto/install-miktex>`_.
+* `NSIS <http://nsis.sourceforge.net/Download>`_ (optional). Used for building packages
+
+Linux
+-----
+
+Red Hat/Cent OS/Fedora
+^^^^^^^^^^^^^^^^^^^^^^
+
+Follow the instructions at http://download.mantidproject.org/redhat.html to add the
+stable release yum repository and then install the ``mantid-developer`` package:
+
+.. code-block:: sh
+
+   yum install mantid-developer
+
+Ubuntu
+^^^^^^
+
+Follow the instructions at http://download.mantidproject.org/ubuntu.html to add the
+stable release repository and mantid ppa. Download the latest
+`mantid-developer <https://sourceforge.net/projects/mantid/files/developer>`_
+package and install it:
+
+.. code-block:: sh
+
+   apt install gdebi-core
+   apt install ~/Downloads/mantid-developer.X.Y.Z.deb
+
+where ``X.Y.Z`` should be replaced with the version that was downloaded.
+

dev-docs/source/_static/color_ranking_definitions.js

+
+$(document).ready(function() {
+             $('.ranking-top-1').parent().addClass('ranking-top-1-parent');
+             $('.ranking-top-2').parent().addClass('ranking-top-2-parent');
+             $('.ranking-med-3').parent().addClass('ranking-med-3-parent');
+             $('.ranking-low-4').parent().addClass('ranking-low-4-parent');
+             $('.ranking-low-5').parent().addClass('ranking-low-5-parent');
+});

dev-docs/source/_static/custom.css

+/*-------------------- $GENERAL --------------------*/
+
+#table-of-contents { border: none; }
+
+/*-------------------- $NAV --------------------*/
+
+.navbar-version { display: none; }
+
+/*-------------------- $LINKS --------------------*/
+
+a {
+  color: #009933;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #009933;
+  text-decoration: underline;
+}
+
+/*-------------------- $SPACING --------------------*/
+
+body { font-size: 1.6em; } /* 16px */
+
+h1{
+  margin-top: 0;
+}
+
+/*-------------------- $MATH ----------------------*/
+
+img.math {
+    vertical-align: middle;
+}
+
+div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+/*-------------------- $IMAGES --------------------*/
+
+.screenshot {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  padding-bottom: 0.1em;
+}
+
+.caption {
+  text-align: center;
+  font-size: 0.9em;
+}
+
+.navbar-brand {
+  padding: 4px 15px 0px 15px;
+}
+
+.navbar-brand > img{
+  width: 85px;
+}
+
+/*-------------------- $TABLES --------------------*/
+
+table {
+  width: 100%;
+  border-collapse: collapse;
+  margin: 1.6em 0;
+}
+
+/* Zebra striping */
+tr:nth-of-type(odd) { background: white; }
+
+tr:hover { background-color: whiteSmoke; }
+
+th {
+  background: #E0DFDE;
+  font-size: 1.3em;
+}
+
+td, th {
+  padding: .75em;
+  border: 1px solid #CCC;
+  text-align: left;
+}
+
+/*-------------------- $SPHINX-OVERRIDES --------------------*/
+
+.warning { overflow: hidden; }
+
+/*-------------------- $MEDIA-QUERIES --------------------*/
+
+@media (min-width: 1200px) {
+  #table-of-contents {
+    width: auto;
+    max-width: 40%;
+  }
+}
+/*---------------------Coloured_text-------------------------*/
+
+.red {
+    color:red;
+}
+.blue {
+    color:blue;
+}
+.green {
+    color:green;
+}
+
+/*-------Introduced here for colors in table cells, for the comparisons of minimizers-----*/
+.ranking-top-1 {
+    background-color: #fef0d9;
+}
+.ranking-top-2 {
+    background-color: #fdcc8a;
+}
+.ranking-med-3 {
+    background-color: #fc8d59;
+}
+.ranking-low-4 {
+    background-color: #e34a33;
+}
+.ranking-low-5 {
+    background-color: #b30000;
+}

dev-docs/source/_static/epub.css

+/*
+ * epub.css_t
+ * ~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- epub theme.
+ *
+ * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+a:link, a:visited {
+    color: #3333ff;
+    text-decoration: underline;
+}
+
+img {
+    border: 0;
+    max-width: 100%;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-family: sans-serif;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 230px;
+    margin-left: -100%;
+    font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 100%;
+}
+
+img {
+    border: 0;
+    max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li div.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 130%;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+    visibility: hidden;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.field-list ul {
+    padding-left: 100%;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px 7px 0 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px 7px 0 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 110%;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+div.admonition dl {
+    margin-bottom: 0;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+    border: 0 !important;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd p {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+dt:target, .highlighted {
+    background-color: #ddd;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 110%;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.optional {
+    font-size: 130%;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #dddddd;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    font-family: monospace;
+    overflow: auto;
+    overflow-y: hidden;
+}
+
+td.linenos pre {
+    padding: 5px 0px;
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    margin-left: 0.5em;
+}
+
+table.highlighttable td {
+    padding: 0 0.5em 0 0.5em;
+}
+
+tt {
+    font-family: monospace;
+}
+
+tt.descname {
+    background-color: transparent;
+    font-weight: bold;
+    font-size: 1.2em;
+}
+
+tt.descclassname {
+    background-color: transparent;
+}
+
+tt.xref, a tt {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+    background-color: transparent;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+/* -- special divs  --------------------------------------------------------- */
+
+div.quotebar {
+    background-color: #e3eff1;
+    max-width: 250px;
+    float: right;
+    font-family: sans-serif;
+    padding: 7px 7px;
+    border: 1px solid #ccc;
+}
+div.footer {
+    background-color: #e3eff1;
+    padding: 3px 8px 3px 0;
+    clear: both;
+    font-family: sans-serif;
+    font-size: 80%;
+    text-align: right;
+}
+
+div.footer a {
+    text-decoration: underline;
+}
+
+img.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- link-target ----------------------------------------------------------- */
+
+.link-target {
+    font-size: 80%;
+}
+
+table .link-target {
+    /* Do not show links in tables, there is not enough space */
+    display: none;
+}
+
+/* -- font-face ------------------------------------------------------------- */
+
+/*
+@font-face {
+    font-family: "LiberationNarrow";
+    font-style: normal;
+    font-weight: normal;
+    src: url("res:///Data/fonts/LiberationNarrow-Regular.otf")
+        format("opentype");
+}
+@font-face {
+    font-family: "LiberationNarrow";
+    font-style: oblique, italic;
+    font-weight: normal;
+    src: url("res:///Data/fonts/LiberationNarrow-Italic.otf")
+        format("opentype");
+}
+@font-face {
+    font-family: "LiberationNarrow";
+    font-style: normal;
+    font-weight: bold;
+    src: url("res:///Data/fonts/LiberationNarrow-Bold.otf")
+        format("opentype");
+}
+@font-face {
+    font-family: "LiberationNarrow";
+    font-style: oblique, italic;
+    font-weight: bold;
+    src: url("res:///Data/fonts/LiberationNarrow-BoldItalic.otf")
+        format("opentype");
+}
+*/
\ No newline at end of file

dev-docs/source/_templates/category.html

+{# Generates a better view for category pages #}
+
+{% extends "layout.html" %}
+
+{% macro split_to_three_columns(item_list) -%}
+{# Split list into 3 columns #}
+{# Uses bootstrap col-md-4 for each column along with slice(3) to divide input list #}
+{# It currently assumes the items in the list are mantiddoc.directives.categories.PageRef classes #}
+    <div class="row">
+    {%- for column in item_list|slice(3) %}
+      <div class="col-md-4">
+      {%- set first = True %}
+      {%- for item in column %}
+        {%- if (item.name[0] != section or first) %}
+          {%- set section = item.name[0] %}
+          {%- if first != true %}
+            </ul>
+          {%- endif %}
+          <h3 style="font-weight:bold">{{ section }}</h3>
+          <ul>
+        {%- endif %}
+        <li><a href="{{ item.link(outpath) }}">{{ item.name }}</a></li>
+        {%- set first = False -%}
+      {%- endfor -%}
+      </ul>
+      </div>
+    {%- endfor -%}
+    </div>
+{%- endmacro %}
+
+{%- block body -%}
+    <h1> Category: {{ title }} </h1>
+    {% if subcategories %}
+    <br>
+    <h2> Subcategories </h2>
+    {{ split_to_three_columns(subcategories) }}
+    <hr>
+    {% endif %}
+
+    {% if pages %}
+    <h2> Pages </h2>
+    {{ split_to_three_columns(pages) }}
+    {% endif %}
+    
+    {% if parentcategory %}
+    <p> {{ parentcategory }} </p>
+    {% endif %}
+
+{%- endblock -%}
\ No newline at end of file

dev-docs/source/_templates/layout.html

+{% extends "!layout.html" %}
+
+{% block extrahead %}
+{% if builder == "html" %}
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-59110517-1', 'auto');
+  ga('send', 'pageview');
+
+</script>
+{% endif %}
+{% endblock %}
+
+{% block footer %}
+<footer class="footer">
+  <div class="container">
+      <ul class="nav navbar-nav" style=" float: right;">
+      {% if theme_source_link_position == "footer" %}
+        <li>{% include "sourcelink.html" %}</li>
+      {% endif %}
+      {% if theme_navbar_sidebarrel %}
+          {% block sidebarrel %}
+            {% include "relations.html" %}
+          {% endblock %}
+       {% endif %}
+          <li><a href="#">Back to top</a></li>
+       </ul>
+    <p>
+    {%- if show_copyright %}
+      {%- if hasdoc('copyright') %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
+      {%- else %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
+      {%- endif %}
+    {%- endif %}
+    {%- if last_updated %}
+      {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}<br/>
+    {%- endif %}
+    {%- if show_sphinx %}
+      {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
+    {%- endif %}
+    </p>
+  </div>
+</footer>
+{%- endblock %}
+
+{# Custom CSS overrides #}
+{% set bootswatch_css_custom = ['_static/custom.css'] %}

dev-docs/source/_templates/navbar.html

+{# Copied from base bootstrap version and modified to: #}
+{#   Remove search box when in embedded mode (qthelp etc) #}
+{#   Point the main logo anchor to www.mantidproject.org in standard mode and the master document in embedded mode #}
+
+  <div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top == 'true' -%} navbar-fixed-top{%- endif -%}">
+    <div class="container">
+      <div class="navbar-header">
+        {% if (not embedded) %}
+        <!-- .btn-navbar is used as the toggle for collapsed navbar content -->
+        <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </button>
+        <a class="navbar-brand" href="http://www.mantidproject.org">
+        {%- else -%}
+        <a class="navbar-brand" href="{{ pathto(master_doc) }}">
+        {%- endif -%}
+          {%- block sidebarlogo %}
+            {%- if logo %}<img src="{{ pathto('_static/' + logo, 1) }}">{%- endif %}
+          {%- endblock %}
+          {% if theme_navbar_title -%}{{ theme_navbar_title|e }}{%- else -%}{{ project|e }}{%- endif -%}
+        </a>
+        <span class="navbar-text navbar-version pull-left"><b>{{ version|e }}</b></span>
+      </div>
+
+      {% if (not embedded) %}
+        <div class="collapse navbar-collapse nav-collapse">
+      {% else %}
+        <div>
+      {% endif %}
+          <ul class="nav navbar-nav">
+            <li class="divider-vertical"></li>
+            {% if theme_navbar_links %}
+              {%- for link in theme_navbar_links %}
+                <li><a href="{{ pathto(*link[1:]) }}">{{ link[0] }}</a></li>
+              {%- endfor %}
+            {% endif %}
+            {% block navbartoc %}
+              {% include "globaltoc.html" %}
+              {% if theme_navbar_pagenav %}
+                {% include "navbartoc.html" %}
+              {% endif %}
+            {% endblock %}
+            {% block navbarextra %}
+            {% endblock %}
+            {% if theme_source_link_position == "nav" %}
+              <li class="hidden-sm">{% include "sourcelink.html" %}</li>
+            {% endif %}
+          </ul>
+          {%- if (not embedded) -%}
+            {% block navbarsearch %}
+              {% include "navbarsearchbox.html" %}
+            {% endblock %}
+          {%- endif -%}
+        </div>
+    </div>
+  </div>

dev-docs/source/_templates/redirect.html

+<!DOCTYPE HTML>
+<html lang="en-US">
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="refresh" content="1;{{ target }}">
+    <script type="text/javascript">
+        window.location.href = "{{ target }}"
+    </script>
+    <title>Page Redirection</title>
+</head>
+<body>
+  <!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
+  If you are not redirected automatically, follow the <a href="{{ target }}">link to {{ name }}</a>
+</body>
+</html>
\ No newline at end of file

dev-docs/source/conf.py

+# -*- mode: python -*-
+# -*- coding: utf-8 -*-
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+import sphinx_bootstrap_theme # checked at cmake time
+
+# -- General configuration ------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+     # we use pngmath over mathjax so that the the offline help isn't reliant on
+     # anything external and we don't need to include the large mathjax package
+    'sphinx.ext.pngmath',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'MantidProject'
+copyright = u'2007-2018, Mantid'
+
+# 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.
+#
+version_str = 'X.Y.Z'
+# The short X.Y version.
+version = ".".join(version_str.split(".")[:2])
+# The full version, including alpha/beta/rc tags.
+release = version_str
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for pngmath --------------------------------------------------
+
+# Load the preview package into latex
+pngmath_latex_preamble=r'\usepackage[active]{preview}'
+
+# Ensures that the vertical alignment of equations is correct.
+# See http://sphinx-doc.org/ext/math.html#confval-pngmath_use_preview
+pngmath_use_preview = True
+
+# -- HTML output ----------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'bootstrap'
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# The "title" for HTML documentation generated with Sphinx' templates. This is appended to the <title> tag of individual pages
+# and used in the navigation bar as the "topmost" element.
+html_title = ""
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = os.path.relpath(os.path.join('..', '..', 'images', 'Mantid_Logo_Transparent.png'))
+
+# 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']
+
+# 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 documentation.
+#html_extra_path = []
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = True
+
+# Hide the Sphinx usage as we reference it on github instead.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = False
+
+# Theme-specific options to customize the look and feel of a theme.
+# We config the bootstrap settings here, and apply CSS changes in
+# custom.css rather than here.
+html_theme_options = {
+    # Navigation bar title.
+    'navbar_title': " ", # deliberate single space so it's not visible
+    # Tab name for entire site.
+    'navbar_site_name': "Mantid",
+    # Add links to the nav bar. Third param of tuple is true to create absolute url.
+    'navbar_links': [
+        ("Home", "http://www.mantidproject.org", True),
+        ("Download", "http://download.mantidproject.org", True),
+        ("Documentation", "http://www.mantidproject.org/Documentation", True),
+        ("Contact Us", "http://www.mantidproject.org/Contact", True),
+    ],
+    # Do not show the "Show source" button.
+    'source_link_position': "no",
+    # Remove the local TOC from the nav bar
+    'navbar_pagenav': False,
+    # Hide the next/previous in the nav bar.
+    'navbar_sidebarrel': True,
+    # Use the latest version.
+    'bootstrap_version': "3",
+    # Ensure the nav bar always stays on top of page.
+    'navbar_fixed_top': "false",
+}
+
+# -- Options for Epub output ---------------------------------------------------
+# This flag determines if a toc entry is inserted again at the beginning of its nested toc listing.
+# This allows easier navigation to the top of a chapter, but can be confusing because it mixes entries of different depth in one list.
+# The default value is True.
+epub_tocdup = True
+
+#This setting control the scope of the epub table of contents
+epub_tocscope = 'includehidden'
+
+#The author of the document. This is put in the Dublin Core metadata. The default value is 'unknown'.
+epub_author = "The Mantid Project"
+
+#The publisher of the document. This is put in the Dublin Core metadata. You may use any sensible string, e.g. the project homepage.
+epub_publisher = "The Mantid Project"
+
+#An identifier for the document. This is put in the Dublin Core metadata.
+#For published documents this is the ISBN number, but you can also use an alternative scheme, e.g. the project homepage.
+#The default value is 'unknown'.
+epub_identifier = "www.mantidproject.org"
+
+#The publication scheme for the epub_identifier. This is put in the Dublin Core metadata.
+#For published books the scheme is 'ISBN'. If you use the project homepage, 'URL' seems reasonable.
+#The default value is 'unknown'.
+epub_scheme='URL'
+
+#A unique identifier for the document. This is put in the Dublin Core metadata. You may use a random string.
+#The default value is 'unknown'.
+epub_uid = "Mantid Reference: " + version
+
+# -- Link to other projects ----------------------------------------------------
+
+intersphinx_mapping = {
+    'h5py': ('http://docs.h5py.org/en/latest/', None),
+    'matplotlib': ('http://matplotlib.org', None),
+    'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+    'python': ('https://docs.python.org/3/', None),
+    'SciPy': ('http://docs.scipy.org/doc/scipy/reference', None),
+    'mantid': ('http://docs.mantidproject.org/', None)
+}