conf Namespace Reference

Functions
def	setup (app)

Variables
string	author = 'Wageningen University'
string	breathe_default_project = "Fields2Cover"
dictionary	breathe_projects = {"Fields2Cover": "../build/docs/doc_doxygen/xml/index.xml"}
string	copyright = '2020-2024, Wageningen University'
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
dictionary	exhale_args
list	extensions
string	github_url = 'https://www.github.com/Fields2Cover/Fields2Cover'
string	highlight_language = 'cpp'
string	html_baseurl = 'https://fields2cover.github.io/'
string	html_favicon = "figures/favicon/favicon.ico"
string	html_logo = "figures/logo_fields2cover.png"
string	html_theme = 'sphinx_rtd_theme'
dictionary	html_theme_options
string	primary_domain = 'cpp'
string	project = 'Fields2Cover'
string	release = 'latest'
list	source_suffix = [".rst", ".md"]
list	templates_path = ['_templates']

Function Documentation

setup()

def conf.setup

(

app

)

Definition at line 100 of file conf.py.

Variable Documentation

author

string conf.author = 'Wageningen University'

Definition at line 25 of file conf.py.

breathe_default_project

string conf.breathe_default_project = "Fields2Cover"

Definition at line 60 of file conf.py.

breathe_projects

dictionary conf.breathe_projects = {"Fields2Cover": "../build/docs/doc_doxygen/xml/index.xml"}

Definition at line 59 of file conf.py.

copyright

string conf.copyright = '2020-2024, Wageningen University'

Definition at line 24 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Definition at line 75 of file conf.py.

exhale_args

dictionary conf.exhale_args

Initial value:

=   {
    "containmentFolder"    : "./api/",
    "rootFileName"         : "f2c_library.rst",
    "rootFileTitle"        : "API",
    "doxygenStripFromPath" : ".."
}

Definition at line 62 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.autosectionlabel',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx_sitemap',
    'sphinx_code_tabs',
    'sphinx.ext.inheritance_diagram',
    "exhale",
    "breathe",
    "m2r2"
]

Definition at line 39 of file conf.py.

github_url

string conf.github_url = 'https://www.github.com/Fields2Cover/Fields2Cover'

Definition at line 97 of file conf.py.

highlight_language

string conf.highlight_language = 'cpp'

Definition at line 31 of file conf.py.

html_baseurl

string conf.html_baseurl = 'https://fields2cover.github.io/'

Definition at line 90 of file conf.py.

html_favicon

string conf.html_favicon = "figures/favicon/favicon.ico"

Definition at line 92 of file conf.py.

html_logo

string conf.html_logo = "figures/logo_fields2cover.png"

Definition at line 91 of file conf.py.

html_theme

string conf.html_theme = 'sphinx_rtd_theme'

Definition at line 83 of file conf.py.

html_theme_options

dictionary conf.html_theme_options

Initial value:

=  {
    'logo_only': True,
    'display_version': False,
}

Definition at line 93 of file conf.py.

primary_domain

string conf.primary_domain = 'cpp'

Definition at line 30 of file conf.py.

project

string conf.project = 'Fields2Cover'

Definition at line 23 of file conf.py.

release

string conf.release = 'latest'

Definition at line 28 of file conf.py.

source_suffix

list conf.source_suffix = [".rst", ".md"]

Definition at line 57 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 70 of file conf.py.