conf.py

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'A.T.O.M\'s Wiki'
copyright = '2022, A.T.O.M'
author = 'A.T.O.M'
release = '0.3.2'
html_logo = 'images/logo_bg.jpg'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['sphinx.ext.githubpages', 'myst_parser', 'sphinx_copybutton']

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'readme.md', 'contributing.md']



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

# -- Aditional configuration -------------------------------------------------

version = u'0.3.0'
master_doc = 'index'
pygments_style = 'sphinx'

html_favicon = "https://github.com/atom-robotics-lab/assets/blob/main/logo_with_background.jpg?raw=true"

html_context = {
    "display_github": True, # Integrate GitHub
    "github_user": "atom-robotics-lab", # Username
    "github_repo": "wiki", # Repository name
    "github_version": "main", # Version
    "conf_py_path": "/", # Path in the checkout to the docs root
}