conf

Attributes

project
copyright
author
version
release
extensions
autoapi_type
autoapi_dirs
breathe_projects
breathe_default_project
breathe_default_members
templates_path
source_suffix
master_doc
language
exclude_patterns
pygments_style
html_theme
html_theme_options
html_static_path
html_css_files
html_logo
htmlhelp_basename
latex_elements
latex_documents
man_pages
texinfo_documents
epub_title
epub_exclude_files

Functions

configure_doxyfile(→ None)	Mimics the configure_file functionality in cmake.
run_doxygen(→ None)	Runs the doxygen command in the passed in directory.
generate_doxygen_xml(→ None)	Generates the doxygen XML for breathe.
setup(→ None)	Adds generate_doxygen_xml hook to generate the doxygen XML for breathe.

Module Contents

conf.project = 'RJ RC Software'

conf.copyright = '2025, RoboJackets'

conf.author = 'RoboJackets RoboCup Project'

conf.version = ''

conf.release = ''

conf.extensions = ['breathe', 'autoapi.extension']

conf.autoapi_type = 'python'

conf.autoapi_dirs = ['.']

conf.breathe_projects

conf.breathe_default_project = 'rj_robocup'

conf.breathe_default_members = ('members', 'protected-members', 'private-members', 'undoc-members')

conf.templates_path = ['_templates']

conf.source_suffix = '.rst'

conf.master_doc = 'index'

conf.language = 'en'

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

conf.pygments_style = None

conf.html_theme = 'sphinx_rtd_theme'

conf.html_theme_options

conf.html_static_path = ['_static']

conf.html_css_files = ['custom.css']

conf.html_logo = '_static/RoboBuzz.svg'

conf.htmlhelp_basename = 'rj_robocupdoc'

conf.latex_elements

conf.latex_documents

conf.man_pages

conf.texinfo_documents

conf.epub_title = 'RJ RC Software'

conf.epub_exclude_files = ['search.html']

conf.configure_doxyfile(input_dir: pathlib.Path, output_dir: pathlib.Path, doxyfile_dir: pathlib.Path) → None

Mimics the configure_file functionality in cmake. :param input_dir: Input directory for Doxygen. :param output_dir: Output directory for Doxygen. :param doxyfile_dir: The directory of the Doxyfile.

conf.run_doxygen(doxyfile_dir: pathlib.Path) → None

Runs the doxygen command in the passed in directory. :param doxyfile_dir: Path to the directory containing the Doxyfile.

conf.generate_doxygen_xml(app: sphinx.application.Sphinx) → None

Generates the doxygen XML for breathe. :param app: Application object representing the Sphinx process

conf.setup(app: sphinx.application.Sphinx) → None

Adds generate_doxygen_xml hook to generate the doxygen XML for breathe. :param app: Application object representing the Sphinx process