LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-12-25 13:53:40 +01:00
Code Issues Releases Wiki Activity

Work on new documentation structure

Browse Source 
It is just the structure for now. Some cleaning of useless files as well.
This commit is contained in:
Michel Ferrero 2013-08-22 16:20:41 +02:00
parent 6fd3fb091d
commit a23c6a231b
15 changed files with 138 additions and 709 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
doc/_templates/index.html vendored
View File

@ -1,193 +0,0 @@
{% extends "layout.html" %}
{% block footer %}
{{ super() }}
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-36559097-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
{% endblock %}
{% set title = 'Home' %}
{% block body %}
<h1>User manual</h1>
<p style="margin-top:10px"> <strong> TRIQS basic components:</strong> </p>
<table class="contentstable" align="center">
<tr valign="top"><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('introduction/introduction') }}">
Introduction</a><br>
<span class="linkdescr">
Why {{project}} and what does it provide?
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('green/green') }}">
Green's functions</a><br>
<span class="linkdescr">
Learn how to use local Green's functions.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('data_analysis/contents') }}">
Manage and analyze data </a><br>
<span class="linkdescr">
Archiving in HDF5, plotting, fitting, scripting...
</span></p>
</td><td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('installation/install') }}">
Installation</a><br>
<span class="linkdescr">
Quickly install {{project}} to your system.
</span></p>
<p class="biglink">
<a class="biglink" href="{{ pathto('lattice/lattice') }}">
Bravais lattices and related tools</a><br>
<span class="linkdescr">
See how to use simple lattices in {{project}}.
</span></p>
</td></tr></table>
<p style="margin-top:10px"> <strong>Extension modules:</strong> </p>
<table class="contentstable" align="center">
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('solvers/solvers') }}">
Quantum impurity solvers & DMFT</a><br>
<span class="linkdescr">
Use quantum impurity solvers with {{project}}.
</span>
</p>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('wien2k/wien2k') }}">
Wien2TRIQS</a><br>
<span class="linkdescr">
Use {{project}} in realistic calculations.
</span>
</p>
</td>
</tr>
</table>
<p style="margin-top:10px"> <strong>C++ Libraries:</strong> </p>
<table class="contentstable" align="center">
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('reference/c++/learn/intro') }}">
Develop with TRIQS </a><br>
<span class="linkdescr">
A guide to the development of projects using TRIQS.
</span>
</p>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('reference/c++/arrays/contents') }}">
Array library </a><br>
<span class="linkdescr">
C++ multi-dimensional arrays.
</span>
</p>
</td>
</tr>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('reference/c++/mctools/intro') }}">
Monte-Carlo Tools </a><br>
<span class="linkdescr">
Quickly write Monte-Carlo codes.
</span>
</p>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('reference/c++/det_manip/det_manip') }}">
Fast update of matrices </a><br>
<span class="linkdescr">
A simple class for fast update of determinant and inverse ...
</span>
</p>
</td>
</tr>
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('reference/c++/utility') }}">
Utility </a><br>
<span class="linkdescr">
Exceptions, macros, etc...
</span>
</p>
</td>
</tr>
</table>
<p style="margin-top:10px"> <strong>More about the {{project}} project:</strong> </p>
<table class="contentstable" align="center">
<tr valign="top">
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('faq/faq') }}">
Frequently asked questions</a><br>
<span class="linkdescr">
Find answers to the most common questions.
</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto('legal/legal') }}">
License, citations and disclaimer</a><br>
<span class="linkdescr">
Under what license is TRIQS? How to cite TRIQS.
</span>
</p>
</td>
<td width="50%">
<p class="biglink">
<a class="biglink" href="{{ pathto('license/collaboration') }}">
The TRIQS collaboration</a><br>
<span class="linkdescr">
Who's behind {{project}}? Find the list of contributors here!
</span>
</p>
</td>
</tr>
</table>
{% endblock %}

19
doc/_templates/layout.html vendored
View File

@ -1,19 +0,0 @@
{% extends "!layout.html" %}
{% block extrahead %}
{{ super() }}
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-36559097-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
{% endblock %}

33
doc/applications.rst Normal file
View File

@ -0,0 +1,33 @@
.. _applications:
Applications based on TRIQS
===========================
Wien2TRIQS
----------
Wien2TRIQS is an interface to Wien2k for LDA+DMFT calculation. It allows
you to turn band-structure calculations obtained from the Wien2k package to
inputs to full-fledged LDA+DMFT calculations in a few lines!
More info `here <http://ipht.cea.fr/triqs/new/cthyb_matrix/contents.html>`_.
Hybridization-expansion matrix solver
-------------------------------------
The hybridization-expansion matrix solver allows to solve the generic problem
of a quantum impurity embedded in a conduction bath. It is based on a quantum
Monte Carlo algorithm that stochastically samples the diagrams of a
hybridization expansion of the partition function.
More info here
Hubbard I solver
----------------
This solver gives the Hubbard I solution of a quantum impurity problem,
i.e. it solves the atomic limit. This simple approximation allows to have
very quick answer even for large multiband systems.
More info here

34
doc/authors.rst Normal file
View File

@ -0,0 +1,34 @@
:orphan:
Authors
=======
The TRIQS library is developped by bla bla bla bla bla....
as described in reference [#triqs]_.
License
=======
The matrix solver is published under the `GNU General Public License, version 3
<http://www.gnu.org/licenses/gpl.html>`_.
Quotation
=========
This application is a part of our scientific work and we would appreciate if
projects using it will include a citation to the following paper. In
order to help you, we provide a BibTeX entry.
.. [#triqs] `AUTHORS, JOURNAL, YEAR <http://link>`_ (:download:`bibtex file <triqs.bib>`)
If you find the application useful, giving proper reference and citation is
indeed a simple way to help convincing funding sources that such projects are
useful for our community and should be supported.
Disclaimer
==========
The program is provided as is, i.e. WITHOUT ANY WARRANTY of any kind, as
stated in the license. In particular, its authors and contributors will take
no responsability for any possible bugs or any improper use of these programs,
including those resulting in incorrect scientific publications.

23
doc/bugs.rst Normal file
View File

@ -0,0 +1,23 @@
:orphan:
Reporting bugs
==============
Please report all problems and bugs directly at the github issue page
`<https://github.com/TRIQS/triqs/issues>`_. In order to make it easier
for us to solve the issue please follow these guidelines:
#. In all cases specify which version of the application you are using. You can
find the version number in the file :file:`README.txt` at the root of the
application sources.
#. If you have a problem during the installation, give us information about
your operating system and the compiler you are using. Include the outputs of
the ``cmake`` and ``make`` commands as well as the ``CMakeCache.txt`` file
which is in the build directory. Please include these outputs in a
`gist <http://gist.github.com/>`_ file referenced in the issue.
#. If you are experiencing a problem during the execution of the application, provide
a script which allows to quickly reproduce the problem.
Thanks!

4
doc/bundles.rst Normal file
View File

@ -0,0 +1,4 @@
.. _bundles:
Bundles
=======

9
doc/conf.py.in
View File

@ -61,7 +61,7 @@ autoclass_content = "both"
mathjax_path = "@MATHJAX_PATH@/MathJax.js?config=default"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['@TRIQS_SOURCE_DIR@/doc/_templates']
#templates_path = ['@TRIQS_SOURCE_DIR@/doc/_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@ -70,7 +70,7 @@ source_suffix = '.rst'
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'contents'
master_doc = 'index'
# General information about the project.
project = u'TRIQS'
@ -143,8 +143,7 @@ doxylink = { 'doxy' : ('@CMAKE_CURRENT_BINARY_DIR@/doxy.tag', 'doxy_triqs') }
# given in html_static_path.
#html_style = 'default.css'
html_theme_path = ["@TRIQS_SOURCE_DIR@/doc/themes/"]
html_theme = "agogo"
#html_theme = "default"
html_theme = "triqs"
#html_theme_options = { "pagewidth": "80em", "documentwidth" : "60em" }
@ -182,7 +181,7 @@ html_last_updated_fmt = '%b %d, %Y'
# Additional templates that should be rendered to pages, maps page names to
# template names.
html_additional_pages = { 'index':'index.html' }
#html_additional_pages = { 'index':'index.html' }
# If false, no module index is generated.
#html_use_modindex = True

4
doc/contents.rst
View File

@ -1,3 +1,5 @@
.. _documentation:
Table of contents
=================
@ -10,5 +12,3 @@ Table of contents
reference/python/contents
reference/c++/contents
..
reference/applications/contents

21
doc/faq/faq.rst
View File

@ -1,21 +0,0 @@
.. index:: FAQ
Frequently asked questions
===========================
Documentation
-------------
.. toctree::
:maxdepth: 1
typeerrorunicode
Installation
------------
.. toctree::
:maxdepth: 1
relativedirforboost

7
doc/faq/relativedirforboost.rst
View File

@ -1,7 +0,0 @@
Cannot find source file "archive_exception.cpp"
===============================================
If you get this message when you call cmake, it is probably because you gave a
*relative* path for the boost sources ``BOOST_SOURCE_DIR`` (like
``../../../boost_1_47``). You must use an absolute path for
``BOOST_SOURCE_DIR``, like ``/path/to/boost_1_47``.

7
doc/faq/typeerrorunicode.rst
View File

@ -1,7 +0,0 @@
TypeError: coercing to Unicode: need string or buffer, dict found
-----------------------------------------------------------------
If this appears when the documentation is produced, just delete the
.matplotlib directory in your home and start again. The reason for
the bug is that different versions of matplotlib produce different
formats for font caches that are not compatible

27
doc/index.rst Normal file
View File

@ -0,0 +1,27 @@
Welcome to TRIQS
================
TRIQS is a scientific project that provides a set of tools for the study of
interacting quantum systems. It allows to quickly implement many-body
calculations and explore new theoretical and phenomenological ideas within a
flexible, easy-to-use python environment (à la Matlab).
Documentation
=============
Link to :ref:`documentation <documentation>`.
TRIQS-based applications
========================
Some applications are supported by the TRIQS collaboration.
Link to :ref:`applications <applications>`.
Download
========
From git as described in :ref:`install <installation>`.
Or get a :ref:`bundled version <bundles>` which provides both the
TRIQS library and all supported applications.

22
doc/installation/install.rst → doc/install.rst
View File

@ -27,9 +27,9 @@ Complete installation instructions for standard systems
.. toctree::
:maxdepth: 1
Ubuntu
linux
install_on_osx_lion
installation/Ubuntu
installation/linux
installation/install_on_osx_lion
Details
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -37,13 +37,13 @@ Details
.. toctree::
:maxdepth: 1
wien2k_inst
dependencies
python
clang
intel
install_options
get_started
changelog
installation/wien2k_inst
installation/dependencies
installation/python
installation/clang
installation/intel
installation/install_options
installation/get_started
installation/changelog

235
doc/reference/c++/conf.py.in
View File

@ -1,235 +0,0 @@
# -*- coding: utf-8 -*-
#
# TRIQS documentation build configuration file, created by
# sphinx-quickstart on Tue Sep 21 10:50:39 2010.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('.'))
# General configuration
# ---------------------
sys.path +=["@CMAKE_BINARY_DIR@/doc/breathe",
"@CMAKE_BINARY_DIR@/doc/mpl","@CMAKE_BINARY_DIR@/doc/autocompile",
"@CMAKE_BINARY_DIR@/doc/sandbox","@CMAKE_BINARY_DIR@/doc"]
# 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.autodoc','sphinx.ext.pngmath']
extensions = ['sphinx.ext.autodoc','sphinx.ext.@SPHINX_MATH_GENERATOR@','breathe','doxylink']
# adding support for matplotlib plots
extensions += [
'matplotlib.sphinxext.only_directives',
'plot_directive',
# 'matplotlib.sphinxext.ipython_directive',
# 'ipython_console_highlighting',
# 'inheritance_diagram',
'numpydoc']
extensions += ['autocompile']
#extensions += ['sandbox']
autocompile_opts = dict(compiler = "@CMAKE_CXX_COMPILER@",
link = "@DOC_AUTOCOMPILE_LINK@".replace(';',' '),
ld_library_path = "@DOC_AUTOCOMPILE_LD_LIBRARY_PATH@".replace(';',' '),
include =''.join([ " -I%s"%arg for arg in "@DOC_AUTOCOMPILE_INCLUDE@".split(';')] ),
definitions =''.join([ " %s"%arg for arg in "@DOC_AUTOCOMPILE_DEFINITIONS@".split(';')] )
)
autoclass_content = "both"
#pngmath_dvipng_args = ['-gamma 1.2', '-D 150', '-bg Transparent']
mathjax_path = "@MATHJAX_PATH@/MathJax.js?config=default"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['@TRIQS_SOURCE_DIR@/doc/developer_manual/.templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'contents'
# General information about the project.
project = u'TRIQS'
copyright = u'2011, the TRIQS collaboration'
# 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 = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#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 documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['build','html']
# 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'
# Options for breathe extension
# -----------------------------
breathe_projects = {
"mc_tools":"@CMAKE_CURRENT_BINARY_DIR@/xml/",
"arrays":"@CMAKE_CURRENT_BINARY_DIR@/xml/",
}
breathe_default_project = "mc_tools"
# Options for doxylink extension
# -----------------------------
doxylink = { 'doxy' : ('@CMAKE_CURRENT_BINARY_DIR@/doxy.tag', 'doxy_triqs') }
# Options for HTML output
# -----------------------
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
#html_style = 'default.css'
html_theme_path = ["@TRIQS_SOURCE_DIR@/doc/themes/"]
html_theme = "agogo"
#html_theme = "default"
#html_theme_options = { "pagewidth": "80em", "documentwidth" : "60em" }
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# 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 = '@TRIQS_SOURCE_DIR@/Doc/misc/python-powered-w-200x80.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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 = ['@TRIQS_SOURCE_DIR@/doc/developer_manual/.static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
# 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 = { 'index':'index.html' }
# If false, no module index is generated.
#html_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
#html_copy_source = 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 = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'TRIQSdoc'
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
('contents', 'TRIQS.tex', ur'TRIQS Documentation',
ur'2011, M. Ferrero and O. Parcollet', '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
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True

209
doc/reference/python/conf.py.in
View File

@ -1,209 +0,0 @@
# -*- coding: utf-8 -*-
#
# TRIQS documentation build configuration file, created by
# sphinx-quickstart on Tue Sep 21 10:50:39 2010.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed automatically).
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
#sys.path.append(os.path.abspath('.'))
# General configuration
# ---------------------
sys.path +=["@CMAKE_BINARY_DIR@/doc/breathe", "@CMAKE_BINARY_DIR@/doc/mpl", "@CMAKE_BINARY_DIR@/doc"]
# 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.autodoc','sphinx.ext.pngmath']
extensions = ['sphinx.ext.autodoc','sphinx.ext.@SPHINX_MATH_GENERATOR@']
# adding support for matplotlib plots
extensions += [
'matplotlib.sphinxext.only_directives',
'plot_directive',
# 'matplotlib.sphinxext.ipython_directive',
# 'ipython_console_highlighting',
# 'inheritance_diagram',
'numpydoc']
autoclass_content = "both"
#pngmath_dvipng_args = ['-gamma 1.2', '-D 150', '-bg Transparent']
mathjax_path = "@MATHJAX_PATH@/MathJax.js?config=default"
# Add any paths that contain templates here, relative to this directory.
templates_path = ['@TRIQS_SOURCE_DIR@/doc/user_manual/.templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'contents'
# General information about the project.
project = u'TRIQS'
copyright = u'2011, The TRIQS collaboration'
# 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 = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#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 documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = ['build','html']
# 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'
# Options for HTML output
# -----------------------
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
#html_style = 'default.css'
html_theme_path = ["@TRIQS_SOURCE_DIR@/doc/themes/"]
html_theme = "agogo"
#html_theme = "default"
#html_theme_options = { "pagewidth": "80em", "documentwidth" : "60em" }
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# 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 = '@TRIQS_SOURCE_DIR@/Doc/misc/python-powered-w-200x80.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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 = ['@TRIQS_SOURCE_DIR@/doc/user_manual/.static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%b %d, %Y'
# 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 = { 'index':'index.html' }
# If false, no module index is generated.
#html_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
#html_copy_source = 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 = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'TRIQSdoc'
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
('contents', 'TRIQS.tex', ur'TRIQS Documentation',
ur'2011, The TRIQS collaboration', '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
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True