Commit 01670c92 authored by Christian Arnold's avatar Christian Arnold

Integrated first version of Sphinx documentation

parent cd089d65
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a54403ec71e99900e401d4e99958ed29
config: 7b785e90b0aab73d4e7c4d97a5b99e32
tags: 645f666f9bcd5a90fca523b33c5a78b7
.. diffTF documentation master file, created by
sphinx-quickstart on Thu Nov 30 12:48:48 2017.
sphinx-quickstart on Thu Nov 30 13:16:14 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
......
......@@ -22,7 +22,6 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
......@@ -86,7 +85,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, Christian Arnold, Ivan berest, Judith B. Zaugg.
&copy;2017, Christian Arnold, Ivan Berest, Judith B. Zaugg.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
......
......@@ -21,7 +21,6 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
......@@ -92,7 +91,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, Christian Arnold, Ivan berest, Judith B. Zaugg.
&copy;2017, Christian Arnold, Ivan Berest, Judith B. Zaugg.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
......
......@@ -21,7 +21,6 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
......@@ -99,7 +98,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2017, Christian Arnold, Ivan berest, Judith B. Zaugg.
&copy;2017, Christian Arnold, Ivan Berest, Judith B. Zaugg.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
......
......@@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
#
# diffTF documentation build configuration file, created by
# sphinx-quickstart on Thu Nov 30 12:48:48 2017.
# sphinx-quickstart on Thu Nov 30 13:16:14 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
......@@ -31,9 +31,7 @@
# 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.todo',
'sphinx.ext.mathjax',
'sphinx.ext.githubpages']
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -49,8 +47,8 @@ master_doc = 'index'
# General information about the project.
project = 'diffTF'
copyright = '2017, Christian Arnold, Ivan berest, Judith B. Zaugg'
author = 'Christian Arnold, Ivan berest, Judith B. Zaugg'
copyright = '2017, Christian Arnold, Ivan Berest, Judith B. Zaugg'
author = 'Christian Arnold, Ivan Berest, Judith B. Zaugg'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......@@ -77,7 +75,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
......@@ -145,7 +143,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'diffTF.tex', 'diffTF Documentation',
'Christian Arnold, Ivan berest, Judith B. Zaugg', 'manual'),
'Christian Arnold, Ivan Berest, Judith B. Zaugg', 'manual'),
]
......
.. diffTF documentation master file, created by
sphinx-quickstart on Thu Nov 30 12:48:48 2017.
sphinx-quickstart on Thu Nov 30 13:16:14 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
......
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=diffTF
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment