Diffusion µSpectre (feat/crystal_plasticity_finite) Browse

crystal_plasticity…

conf.py
View Options

			#!/usr/bin/env python3
			# -- coding: utf-8 --
			#
			# µSpectre documentation build configuration file, created by
			# sphinx-quickstart on Thu Feb 1 12:01:24 2018.
			#
			# 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
			# documentation root, use os.path.abspath to make it absolute, like shown here.
			#
			import os
			import subprocess
			# import sys
			# sys.path.insert(0, os.path.abspath('.'))


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

			# If your documentation 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.autodoc',
			'sphinx.ext.intersphinx',
			'sphinx.ext.todo',
			'sphinx.ext.coverage',
			'sphinx.ext.mathjax',
			'sphinx.ext.viewcode',
			'breathe']
			read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
			if os.environ.get('READTHEDOCS', None) is not None:
			print("${READTHEDOCS} = " + os.environ.get('READTHEDOCS', None))

			if read_the_docs_build:
			muspectre_path = "."
			else:
			muspectre_path = "@CMAKE_CURRENT_BINARY_DIR@"
			os.makedirs("@CMAKE_CURRENT_BINARY_DIR@/_static", exist_ok=True)
			print("muspectre_path = '{}'".format(muspectre_path))
			subprocess.call('ls; pwd', shell=True)
			subprocess.call("cd {} && doxygen".format(muspectre_path), shell=True)

			breathe_projects = {"µSpectre": os.path.join(muspectre_path, "doxygenxml")}
			breathe_default_project = "µSpectre"

			# 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 master toctree document.
			master_doc = 'index'

			# General information about the project.
			project = 'µSpectre'
			copyright = '2018, Till Junge'
			author = 'Till Junge'

			# 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 = 'v0.1'
			# The full version, including alpha/beta/rc tags.
			release = 'v0.1 α'

			# The language for content autogenerated by Sphinx. Refer to documentation
			# 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

			# 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 = ["CmakeLists.txt"]

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

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


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

			# The theme to use for HTML and HTML Help pages. See the documentation for
			# a list of builtin themes.
			#
			on_rtd = os.environ.get('READTHEDOCS') == 'True'
			if on_rtd:
			html_theme = 'default'
			else:
			html_theme = 'classic'

			# 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
			# documentation.
			#
			# html_theme_options = {}

			# 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']

			# Custom sidebar templates, must be a dictionary that maps document names
			# to template names.
			#
			# This is required for the alabaster theme
			# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
			html_sidebars = {
			'**': [
			'relations.html', # needs 'show_related': True theme option to display
			'searchbox.html',
			]
			}


			# -- Options for HTMLHelp output ------------------------------------------

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


			# -- 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': r'''
			\usepackage{amsmath}
			''',

			# 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, 'Spectre.tex', 'µSpectre Documentation',
			'Till Junge', 'manual'),
			]


			# -- 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, 'spectre', 'µSpectre Documentation',
			[author], 1)
			]


			# -- 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, 'Spectre', 'µSpectre Documentation',
			author, 'Spectre', 'One line description of project.',
			'Miscellaneous'),
			]



			# -- Options for Epub output ----------------------------------------------

			# Bibliographic Dublin Core info.
			epub_title = project
			epub_author = author
			epub_publisher = author
			epub_copyright = copyright

			# The unique identifier of the text. This can be a ISBN number
			# or the project homepage.
			#
			# epub_identifier = ''

			# A unique identification for the text.
			#
			# epub_uid = ''

			# A list of files that should not be packed into the epub file.
			epub_exclude_files = ['search.html']



			# Example configuration for intersphinx: refer to the Python standard library.
			intersphinx_mapping = {'https://docs.python.org/': None}
			primary_domain = 'cpp'
			highlight_language = 'cpp'

muSpectre/doc/dev-docs/source/conf.py89116df36865feat/crystal_plasticity…

conf.pyView Options

muSpectre/doc/dev-docs/source/conf.py
89116df36865feat/crystal_plasticity…

conf.py
View Options