Option C Tools
Loading...
Searching...
No Matches
conf Namespace Reference

Variables

str project = 'oct'
str copyright = '2026, Option C Dev Team'
str author = 'Option C Dev Team'
str release = '0.9.1'
list extensions
bool autosectionlabel_prefix_document = True
list myst_enable_extensions
int myst_heading_anchors = 3
dict myst_fence_as_directive = {"mermaid"}
list templates_path = ['../_templates']
list exclude_patterns
list suppress_warnings
bool autosummary_generate = True
dict autodoc_default_options
str html_theme = 'sphinx_book_theme'
list html_static_path = ['../_static']
list html_css_files = ['custom.css']
str html_logo = '../_static/Option_C_logo.svg'
dict html_theme_options

Detailed Description

Purpose
-------
Sphinx configuration for the OCT project documentation build.

Responsibilities
----------------
- Define project metadata (name, version, author, copyright).
- Register Sphinx extensions (MyST, Mermaid, autodoc, Napoleon, etc.).
- Configure HTML theme, static paths, and template paths.

Diagnostics
-----------
Domain: DOCS
L2: documentation build configuration
L3: build configuration details
L4: deep tracing

Contracts
---------
- This file is consumed by ``sphinx-build`` and ``oct docs --sphinx``.
- Paths in ``templates_path`` and ``html_static_path`` are relative to
  the confdir (``docs/_sphinx/``).

Variable Documentation

◆ author

str conf.author = 'Option C Dev Team'

Definition at line 46 of file conf.py.

◆ autodoc_default_options

dict conf.autodoc_default_options
Initial value:
1= {
2 'members': True,
3 'undoc-members': True,
4 'show-inheritance': True,
5}

Definition at line 93 of file conf.py.

◆ autosectionlabel_prefix_document

bool conf.autosectionlabel_prefix_document = True

Definition at line 64 of file conf.py.

◆ autosummary_generate

bool conf.autosummary_generate = True

Definition at line 91 of file conf.py.

◆ copyright

str conf.copyright = '2026, Option C Dev Team'

Definition at line 45 of file conf.py.

◆ exclude_patterns

list conf.exclude_patterns
Initial value:
1= ['html', 'doctrees', 'old', 'code_reviews', 'sphinx_docs',
2 'source', '_sphinx', '_templates', '_autosummary',
3 'doxygen_output', 'doxygen_work_dir',
4 'Thumbs.db', '.DS_Store']

Definition at line 80 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1= [
2 'myst_parser',
3 'sphinxcontrib.mermaid',
4 'sphinx.ext.autosectionlabel',
5 'sphinx_copybutton',
6 'sphinx.ext.autodoc',
7 'sphinx.ext.autosummary',
8 'sphinx.ext.viewcode',
9 'sphinx.ext.inheritance_diagram',
10 'sphinx.ext.napoleon',
11]

Definition at line 51 of file conf.py.

◆ html_css_files

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

Definition at line 103 of file conf.py.

◆ html_logo

str conf.html_logo = '../_static/Option_C_logo.svg'

Definition at line 104 of file conf.py.

◆ html_static_path

list conf.html_static_path = ['../_static']

Definition at line 102 of file conf.py.

◆ html_theme

str conf.html_theme = 'sphinx_book_theme'

Definition at line 101 of file conf.py.

◆ html_theme_options

dict conf.html_theme_options
Initial value:
1= {
2 "repository_url": "https://github.com/available/soon",
3 "use_repository_button": True,
4 "use_fullscreen_button": True,
5 "use_download_button": True,
6 "home_page_in_toc": True,
7 "show_toc_level": 2,
8}

Definition at line 106 of file conf.py.

◆ myst_enable_extensions

list conf.myst_enable_extensions
Initial value:
1= [
2 'colon_fence',
3 'attrs_inline',
4 'smartquotes',
5 'replacements',
6]

Definition at line 66 of file conf.py.

◆ myst_fence_as_directive

dict conf.myst_fence_as_directive = {"mermaid"}

Definition at line 76 of file conf.py.

◆ myst_heading_anchors

int conf.myst_heading_anchors = 3

Definition at line 73 of file conf.py.

◆ project

str conf.project = 'oct'

Definition at line 44 of file conf.py.

◆ release

str conf.release = '0.9.1'

Definition at line 47 of file conf.py.

◆ suppress_warnings

list conf.suppress_warnings
Initial value:
1= ['myst.xref_missing', 'myst.header', 'docutils',
2 'autosectionlabel.*']

Definition at line 86 of file conf.py.

◆ templates_path

list conf.templates_path = ['../_templates']

Definition at line 79 of file conf.py.