Updates to the Minke documentation.

parent 1f23fbe3
Pipeline #55004 passed with stages
in 2 minutes and 49 seconds
/*
* bootstrap-sphinx.css
* ~~~~~~~~~~~~~~~~~~~~
*
* Sphinx stylesheet -- Bootstrap theme.
*/
.navbar-inverse .brand {
color: #FFF;
}
/*
* Reset navbar styles from overrides in:
* https://bitbucket.org/birkenfeld/sphinx/commits/78d8ebf76b630ab4073a7328af9d91e8123b8d96
*/
.navbar .container {
padding-top: 0;
}
.page-top {
top: 0px;
}
{% if theme_navbar_fixed_top|tobool %}
{% if theme_bootstrap_version == "2" %}
@media (min-width: 980px) {
{% endif %}
{% if theme_bootstrap_version == "2" %}
}
{% endif %}
.navbar-inner {
padding-left: 12px !important;
padding-right: 12px !important;
}
{% else %}
{% if theme_bootstrap_version == "2" %}
@media (min-width: 980px) {
.navbar .container {
width: 940px;
}
}
{% endif %}
{% endif %}
table {
border: 0;
}
.highlighttable .code pre {
font-size: 12px;
}
.highlighttable .linenos pre {
word-break: normal;
font-size: 12px;
}
div.highlight {
background: none;
}
a.footnote-reference {
vertical-align: super;
font-size: 75%;
}
table.footnote td.label {
font-size: 100%;
display: block;
line-height: normal;
background: inherit;
}
table.footnote {
width: auto;
margin-bottom: 0px;
}
table.field-list {
width: auto;
}
.footer {
width: 100%;
border-top: 1px solid #ccc;
padding-top: 10px;
}
.bs-sidenav form, .bs-sidenav #sourcelink {
padding: 5px 20px;
}
{% if theme_bootstrap_version == "3" %}
/* The code below is based on the bootstrap website sidebar */
.bs-sidenav.affix {
position: static;
}
/* First level of nav */
.bs-sidenav {
margin-top: 30px;
margin-bottom: 30px;
padding-top: 10px;
padding-bottom: 10px;
text-shadow: 0 1px 0 #fff;
background-color: #f7f5fa;
border-radius: 5px;
}
/* All levels of nav */
.bs-sidenav .nav > li > a {
display: block;
color: #716b7a;
padding: 5px 20px;
}
.bs-sidenav .nav > li > a:hover,
.bs-sidenav .nav > li > a:focus {
text-decoration: none;
background-color: #e5e3e9;
border-right: 1px solid #dbd8e0;
}
.bs-sidenav .nav > .active > a,
.bs-sidenav .nav > .active:hover > a,
.bs-sidenav .nav > .active:focus > a {
font-weight: bold;
color: #563d7c;
background-color: transparent;
border-right: 1px solid #563d7c;
}
.bs-sidenav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 30px;
font-size: 90%;
}
.bs-sidenav .nav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 40px;
font-size: 90%;
}
.bs-sidenav .nav .nav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 50px;
font-size: 90%;
}
/* Show and affix the side nav when space allows it */
@media screen and (min-width: 992px) {
.bs-sidenav .nav > .active > ul {
display: block;
}
/* Widen the fixed sidenav */
.bs-sidenav.affix,
.bs-sidenav.affix-bottom {
width: 213px;
}
.bs-sidenav.affix {
position: fixed; /* Undo the static from mobile first approach */
}
.bs-sidenav.affix-bottom {
position: absolute; /* Undo the static from mobile first approach */
}
.bs-sidenav.affix-bottom .bs-sidenav,
.bs-sidenav.affix .bs-sidenav {
margin-top: 0;
margin-bottom: 0;
}
}
@media screen and (min-width: 1200px) {
/* Widen the fixed sidenav again */
.bs-sidenav.affix-bottom,
.bs-sidenav.affix {
width: 263px;
}
}
{% else %}
.bs-sidenav {
width: 228px;
margin: 30px 0 0;
padding: 10px 0 0 5px;
}
.bs-sidenav ul{
list-style-type: none;
padding-left: 25px;
margin-left: 0; /* bootstrap 2 compatability. */
}
@media (min-width: 1200px) {
.bs-sidenav {
width: 258px;
}
}
/* Desktop
------------------------- */
@media (max-width: 980px) {
.bs-sidenav {
width: 218px;
margin-top: 30px;
margin-right: 0;
}
}
/* Tablet to desktop
------------------------- */
@media (min-width: 768px) and (max-width: 979px) {
.bs-sidenav {
width: 166px;
margin-top: 20px;
}
}
/* Tablet
------------------------- */
@media (max-width: 767px) {
.navbar-version {
padding-left: 5px;
}
.bs-sidenav {
width: auto;
margin-bottom: 20px;
}
.bs-sidenav.affix {
position: static;
top: 0;
}
}
{% endif %}
{% extends "basic/layout.html" %}
{% set theme_css_files = [] %}
{% if theme_bootstrap_version == "3" %}
{% set bootstrap_version, bootstrap_additional_css, navbar_version = "3.3.4", "theme", "" %}
{% set bs_span_prefix = "col-md-" %}
{% else %}
{% set bootstrap_version, bootstrap_additional_css, navbar_version = "2.3.2", "responsive", "-2" %}
{% set bs_span_prefix = "span" %}
{% endif %}
{# Custom CSS overrides #}
{% set bootswatch_css_custom = ['http://www.code.daniel-williams.co.uk/css/main.css', 'https://fonts.googleapis.com/css?family=Open+Sans:300italic,600'] %}
{% if theme_bootswatch_theme and theme_bootswatch_theme != "\"\"" %}
{# BS2 needs "bootstrap-responsive.css". BS3 doesn't. #}
{% if theme_bootstrap_version == "3" %}
{% set theme_css_files = theme_css_files + [
'_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
'_static/bootstrap-sphinx.css'
]
%}
{% else %}
{% set theme_css_files = theme_css_files + [
'_static/bootswatch-' + bootstrap_version + '/' + theme_bootswatch_theme + '/bootstrap.min.css',
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
'_static/bootstrap-sphinx.css'
]
%}
{% endif %}
{% else %}
{% set theme_css_files = theme_css_files + [
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap.min.css',
'_static/bootstrap-' + bootstrap_version + '/css/bootstrap-' + bootstrap_additional_css + '.min.css',
'_static/bootstrap-sphinx.css'
]
%}
{% endif %}
{% if not bootswatch_css_custom %}
{% set bootswatch_css_custom = [] %}
{% endif %}
{% set css_files = css_files + theme_css_files + bootswatch_css_custom %}
{% set script_files = script_files + [
'_static/js/jquery-1.11.0.min.js',
'_static/js/jquery-fix.js',
'_static/bootstrap-' + bootstrap_version + '/js/bootstrap.min.js',
'_static/bootstrap-sphinx.js'
]
%}
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and sidebars %}
{%- set bs_content_width = render_sidebar and "9" or "12"%}
{%- block doctype -%}
<!DOCTYPE html>
{%- endblock %}
{# Sidebar: Rework into our Bootstrap nav section. #}
{% macro navBar() %}
{% include "navbar" + navbar_version + ".html" %}
{% endmacro %}
{% if theme_bootstrap_version == "3" %}
{%- macro bsidebar() %}
{%- if render_sidebar %}
<div class="{{ bs_span_prefix }}3">
<header class="site-header">
<nav class="">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="hexagon">
<a class="sidebar" href="http://code.daniel-williams.co.uk/{{ project.lower()|e }}/"><h1>{{ project|e }}</h1></a>
<em><a class="sidebar" href="http://code.daniel-williams.co.uk/">Daniel Williams</a></em>
</div>
<p>&nbsp;</p>
</nav>
</header>
<div id="sidebar" class="bs-sidenav" role="complementary">
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{% else %}
{%- macro bsidebar() %}
{%- if render_sidebar %}
<div class="{{ bs_span_prefix }}3">
<div id="sidebar" class="bs-sidenav well" data-spy="affix">
{%- for sidebartemplate in sidebars %}
{%- include sidebartemplate %}
{%- endfor %}
</div>
</div>
{%- endif %}
{%- endmacro %}
{% endif %}
{%- block extrahead %}
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
{% endblock %}
{# Silence the sidebar's, relbar's #}
{% block header %}{% endblock %}
{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% block sidebarsourcelink %}{% endblock %}
{%- block content %}
{%- block sidebar1 %}{{ bsidebar() }}{% endblock %}
<div class="{{ bs_span_prefix }}{{ bs_content_width }} content">
{{ navBar() }}
{% block body %}{% endblock %}
{%- endblock %}
{%- block footer %}
<footer class="footer">
<div class="container-fluid">
<p class="pull-right">
<a href="#">Back to top</a>
{% if theme_source_link_position == "footer" %}
<br/>
{% include "sourcelink.html" %}
{% endif %}
</p>
<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-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
{%- endif %}
</p>
</div>
</footer>
</div>
{%- endblock %}
<div id="navbar" class="{{ theme_navbar_class }} navbar-default {% if theme_navbar_fixed_top|tobool -%} {%- endif -%}">
<div class="container-fluid">
<div class="navbar-header">
<!-- .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="{{ pathto(master_doc) }}">
{%- 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>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
{% 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 %}
{% if theme_navbar_sidebarrel %}
{% block sidebarrel %}
{% include "relations.html" %}
{% endblock %}
{% endif %}
{% block navbarextra %}
{% endblock %}
{% if theme_source_link_position == "nav" %}
<li class="hidden-sm">{% include "sourcelink.html" %}</li>
{% endif %}
</ul>
</div>
</div>
</div>
{%- if pagename != "search" %}
<form class="navbar-form" action="{{ pathto('search') }}" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
{%- endif %}
/*
* bootstrap-sphinx.css
* ~~~~~~~~~~~~~~~~~~~~
*
* Sphinx stylesheet -- Bootstrap theme.
*/
.navbar-inverse .brand {
color: #FFF;
}
/*
* Reset navbar styles from overrides in:
* https://bitbucket.org/birkenfeld/sphinx/commits/78d8ebf76b630ab4073a7328af9d91e8123b8d96
*/
.navbar .container {
padding-top: 0;
}
.page-top {
top: 0px;
}
{% if theme_navbar_fixed_top|tobool %}
{% if theme_bootstrap_version == "2" %}
@media (min-width: 980px) {
{% endif %}
{% if theme_bootstrap_version == "2" %}
}
{% endif %}
.navbar-inner {
padding-left: 12px !important;
padding-right: 12px !important;
}
{% else %}
{% if theme_bootstrap_version == "2" %}
@media (min-width: 980px) {
.navbar .container {
width: 940px;
}
}
{% endif %}
{% endif %}
table {
border: 0;
}
.highlighttable .code pre {
font-size: 12px;
}
.highlighttable .linenos pre {
word-break: normal;
font-size: 12px;
}
div.highlight {
background: none;
}
a.footnote-reference {
vertical-align: super;
font-size: 75%;
}
table.footnote td.label {
font-size: 100%;
display: block;
line-height: normal;
background: inherit;
}
table.footnote {
width: auto;
margin-bottom: 0px;
}
table.field-list {
width: auto;
}
.footer {
width: 100%;
border-top: 1px solid #ccc;
padding-top: 10px;
}
.bs-sidenav form, .bs-sidenav #sourcelink {
padding: 5px 20px;
}
{% if theme_bootstrap_version == "3" %}
/* The code below is based on the bootstrap website sidebar */
.bs-sidenav.affix {
position: static;
}
/* First level of nav */
.bs-sidenav {
margin-top: 30px;
margin-bottom: 30px;
padding-top: 10px;
padding-bottom: 10px;
text-shadow: 0 1px 0 #fff;
background-color: #f7f5fa;
border-radius: 5px;
}
/* All levels of nav */
.bs-sidenav .nav > li > a {
display: block;
color: #716b7a;
padding: 5px 20px;
}
.bs-sidenav .nav > li > a:hover,
.bs-sidenav .nav > li > a:focus {
text-decoration: none;
background-color: #e5e3e9;
border-right: 1px solid #dbd8e0;
}
.bs-sidenav .nav > .active > a,
.bs-sidenav .nav > .active:hover > a,
.bs-sidenav .nav > .active:focus > a {
font-weight: bold;
color: #563d7c;
background-color: transparent;
border-right: 1px solid #563d7c;
}
.bs-sidenav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 30px;
font-size: 90%;
}
.bs-sidenav .nav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 40px;
font-size: 90%;
}
.bs-sidenav .nav .nav .nav .nav > li > a {
padding-top: 3px;
padding-bottom: 3px;
padding-left: 50px;
font-size: 90%;
}
/* Show and affix the side nav when space allows it */
@media screen and (min-width: 992px) {
.bs-sidenav .nav > .active > ul {
display: block;
}
/* Widen the fixed sidenav */
.bs-sidenav.affix,
.bs-sidenav.affix-bottom {
width: 213px;
}
.bs-sidenav.affix {
position: fixed; /* Undo the static from mobile first approach */
}
.bs-sidenav.affix-bottom {
position: absolute; /* Undo the static from mobile first approach */
}
.bs-sidenav.affix-bottom .bs-sidenav,
.bs-sidenav.affix .bs-sidenav {
margin-top: 0;
margin-bottom: 0;
}
}
@media screen and (min-width: 1200px) {
/* Widen the fixed sidenav again */
.bs-sidenav.affix-bottom,
.bs-sidenav.affix {
width: 263px;
}
}
{% else %}
.bs-sidenav {
width: 228px;
margin: 30px 0 0;
padding: 10px 0 0 5px;
}
.bs-sidenav ul{
list-style-type: none;
padding-left: 25px;
margin-left: 0; /* bootstrap 2 compatability. */
}
@media (min-width: 1200px) {
.bs-sidenav {
width: 258px;
}
}
/* Desktop
------------------------- */
@media (max-width: 980px) {
.bs-sidenav {
width: 218px;
margin-top: 30px;
margin-right: 0;
}
}
/* Tablet to desktop
------------------------- */
@media (min-width: 768px) and (max-width: 979px) {
.bs-sidenav {
width: 166px;
margin-top: 20px;
}
}
/* Tablet
------------------------- */
@media (max-width: 767px) {
.navbar-version {
padding-left: 5px;
}
.bs-sidenav {
width: auto;
margin-bottom: 20px;
}
.bs-sidenav.affix {
position: static;
top: 0;
}
}
{% endif %}
......@@ -34,7 +34,7 @@ sys.path.insert(0, project_root)
import minke
# Load the bootstrap theme
import sphinx_bootstrap_theme
import sphinx_daniel_theme
# -- General configuration ---------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
......@@ -114,8 +114,8 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme = 'daniel'
html_theme_path = sphinx_daniel_theme.get_html_theme_path()
# 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
......
......@@ -7,7 +7,6 @@
Minke
=====
.. image:: ../minke.png
Minke is a pipeline to produce Burst Mock Data Challenges for the LIGO
Scientific Collaboration. It is capable of producing ad-hoc and
......@@ -32,17 +31,8 @@ The Minke framework aims to be flexible, and easily extended to
include new waveform morphologies, and signal distributions, so if you
find something lacking feel free to make a pull request!
Tutorials
=========
.. toctree::
:maxdepth: 2
tutorial
tutorial-editing
tutorial-SNR-threshold
tutorial-supernova
User Guide
==========
......@@ -54,7 +44,18 @@ User Guide
usage
ringdowns
numerical