conf Namespace Reference

Variables
string	author
string	author
string	author = "Ekumen Research"
string	autodox_outdir
string	autodox_outdir = "_doxygen/generated"
dictionary	autodox_projects
dictionary	autodox_projects = {"reference": ""}
list	bibtex_bibfiles
list	bibtex_bibfiles = ["references.bib"]
string	copyright
string	copyright
string	copyright = "2022-2024 Ekumen, Inc."
list	exclude_patterns
list	exclude_patterns
list	exclude_patterns = ["README.md", "_build", "_external/*.md"]
list	extensions
list	extensions
list	extensions
string	highlight_language
list	html_css_files
list	html_css_files = ["custom.css"]
string	html_favicon
string	html_favicon = "_images/logo_200x200.png"
list	html_js_files
list	html_js_files = ["custom.js"]
	html_last_updated_fmt
	html_last_updated_fmt
list	html_static_path
list	html_static_path
list	html_static_path = ["_static"]
string	html_theme
string	html_theme
string	html_theme = "sphinx_book_theme"
dictionary	html_theme_options
dictionary	html_theme_options
string	language
string	language = "en"
list	myst_enable_extensions
list	myst_enable_extensions = ["colon_fence"]
int	myst_heading_anchors
int	myst_heading_anchors = 4
string	primary_domain
string	project
string	project
string	project = "Beluga ROS"
dictionary	source_suffix
dictionary	source_suffix
list	suppress_warnings
list	suppress_warnings = ["myst.header"]
list	templates_path

Variable Documentation

author

string conf.author = "Ekumen Research"

Definition at line 27 of file conf.py.

autodox_outdir

string conf.autodox_outdir = "_doxygen/generated"

Definition at line 54 of file conf.py.

autodox_projects

dictionary conf.autodox_projects = {"reference": ""}

Definition at line 55 of file conf.py.

bibtex_bibfiles

list conf.bibtex_bibfiles = ["references.bib"]

Definition at line 49 of file conf.py.

copyright

string conf.copyright = "2022-2024 Ekumen, Inc."

Definition at line 26 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ["README.md", "_build", "_external/*.md"]

Definition at line 57 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    "myst_parser",
    "sphinx.ext.mathjax",
    "sphinx.ext.duration",
    "sphinx.ext.graphviz",
    "sphinx_copybutton",
    "sphinx.ext.inheritance_diagram",
    "sphinx_design",
    "sphinx_babel.autodox",
    "sphinxcontrib.bibtex",
]

Definition at line 37 of file conf.py.

html_css_files

list conf.html_css_files = ["custom.css"]

Definition at line 82 of file conf.py.

html_favicon

string conf.html_favicon = "_images/logo_200x200.png"

Definition at line 81 of file conf.py.

html_js_files

list conf.html_js_files = ["custom.js"]

Definition at line 83 of file conf.py.

html_last_updated_fmt

conf.html_last_updated_fmt

Initial value:

=  subprocess.check_output(
    ["git", "log", "--pretty=format:'%ad, %h'", "-n1"]
).decode("utf-8")

Definition at line 78 of file conf.py.

html_static_path

list conf.html_static_path = ["_static"]

Definition at line 84 of file conf.py.

html_theme

string conf.html_theme = "sphinx_book_theme"

Definition at line 63 of file conf.py.

html_theme_options

dictionary conf.html_theme_options

Initial value:

=  {
    "show_navbar_depth": 1,
    "collapse_navbar": True,
    "collapse_navigation": True,
    "repository_branch": "main",
    "repository_url": "https://github.com/Ekumen-OS/beluga",
    "use_repository_button": True,
    "use_edit_page_button": False,
    "home_page_in_toc": True,
    "logo": {
        "image_light": "_images/logo_with_name_light.png",
        "image_dark": "_images/logo_with_name_dark.png",
    },
}

Definition at line 64 of file conf.py.

language

string conf.language = "en"

Definition at line 35 of file conf.py.

myst_enable_extensions

list conf.myst_enable_extensions = ["colon_fence"]

Definition at line 51 of file conf.py.

myst_heading_anchors

int conf.myst_heading_anchors = 4

Definition at line 52 of file conf.py.

project

string conf.project = "Beluga ROS"

Definition at line 25 of file conf.py.

source_suffix

dictionary conf.source_suffix

Initial value:

=  {
    ".rst": "restructuredtext",
    ".md": "markdown",
}

Definition at line 31 of file conf.py.

suppress_warnings

list conf.suppress_warnings = ["myst.header"]

Definition at line 58 of file conf.py.