conf.py

# Configuration file for the Sphinx documentation builder.
#
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import sys, os

# -- Project information

project = "Unturned"
copyright = "2023, Smartly Dressed Games"
author = "Smartly Dressed Games"

version = "3.x"
release = version

# -- General configuration
sys.path.append(os.path.abspath("_extensions")) # also find extensions within this directory
extensions = [
    "notfound.extension",  # Adds "404 Not Found" pages
    'sphinx.ext.duration',
    'sphinx.ext.doctest',
    'sphinx.ext.autodoc',
    'sphinx.ext.autosummary',
    'sphinx_copybutton',
    'sphinx.ext.intersphinx',
    'sphinxext.opengraph', # OpenGraph support (e.g., URLs posted onto our Discourse forum will appear as OneBox embeds)
    'sphinx_rtd_theme', # "Read the Docs Sphinx Theme" https://sphinx-rtd-theme.readthedocs.io/en/stable/index.html
    'sphinx_tabs.tabs',
    # -- Locally-installed modules
    'unturned_lexer',
]

exclude_patterns = [
    '.venv/*' # Contains installed packages which may have rst files we don't want included in source files.
]

intersphinx_mapping = {
    'python': ('https://docs.python.org/3/', None),
    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
}
intersphinx_disabled_domains = ['std']

templates_path = ['_templates']

# -- Options for HTML output

html_theme = 'sphinx_rtd_theme'

# RTD theme options are documented here: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
html_theme_options = {
    # Toc options
    'collapse_navigation': True,
}

# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")

# These folders are copied to the documentation's HTML output
html_static_path = ["_static"]

# These paths are either relative to html_static_path
# or fully qualified paths (e.g. https://...)
html_css_files = [
    'css/custom.css',
    'css/toctree_collapse.css',
]

html_js_files = [
    "js/toctree_collapse.js",
]

# -- Options for EPUB output
epub_show_urls = 'footnote'