2021-03-24 20:00:53 +03:00
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
#
|
|
|
|
# This file only contains a selection of the most common options. For a full
|
|
|
|
# list see the documentation:
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
import datetime
|
|
|
|
|
2021-03-24 20:00:53 +03:00
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
#
|
|
|
|
import os
|
|
|
|
import sys
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
sys.path.insert(0, os.path.abspath("."))
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
project = "Bergamot Translator"
|
|
|
|
copyright = "2021-2022 Bergamot Translator Team"
|
|
|
|
author = "Bergamot Translator Team"
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
|
# TODO: add GitHub commit hash to the version
|
2022-01-26 23:33:43 +03:00
|
|
|
version_file = os.path.join(
|
|
|
|
os.path.dirname(os.path.dirname(__file__)), "BERGAMOT_VERSION"
|
|
|
|
)
|
2021-03-24 20:00:53 +03:00
|
|
|
with open(os.path.abspath(version_file)) as f:
|
|
|
|
version = f.read().strip()
|
2022-01-26 23:33:43 +03:00
|
|
|
release = version + " " + str(datetime.date.today())
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
# ones.
|
|
|
|
extensions = [
|
2022-01-26 23:33:43 +03:00
|
|
|
"sphinx.ext.mathjax",
|
|
|
|
"sphinx.ext.todo",
|
|
|
|
"breathe",
|
|
|
|
"exhale",
|
|
|
|
"recommonmark",
|
|
|
|
"sphinx.ext.autodoc",
|
|
|
|
"sphinxarg.ext",
|
2021-03-24 20:00:53 +03:00
|
|
|
]
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
2022-01-26 23:33:43 +03:00
|
|
|
templates_path = ["_templates"]
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
exclude_patterns = [
|
2022-01-26 23:33:43 +03:00
|
|
|
"build",
|
|
|
|
"doxygen",
|
|
|
|
"venv",
|
|
|
|
"README.md",
|
2021-03-24 20:00:53 +03:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
# a list of builtin themes.
|
|
|
|
#
|
2022-01-26 23:33:43 +03:00
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
htmlhelp_basename = "bergamot-translator"
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
2022-01-26 23:33:43 +03:00
|
|
|
html_static_path = ["_static"]
|
|
|
|
html_css_files = ["css/custom.css"]
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
# The base URL which points to the root of the HTML documentation
|
2022-01-26 23:33:43 +03:00
|
|
|
html_baseurl = "https://browser.mt/docs"
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
breathe_projects = {"bergamot-translator": "./doxygen/xml"}
|
|
|
|
breathe_default_project = "bergamot-translator"
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
doxygen_config = """
|
2021-05-31 16:44:59 +03:00
|
|
|
INPUT = ../src ../app
|
2021-03-24 20:00:53 +03:00
|
|
|
EXCLUDE += ../3rd_party
|
|
|
|
EXCLUDE += ../src/tests
|
|
|
|
EXCLUDE_PATTERNS = *.md *.txt
|
|
|
|
FILE_PATTERNS += *.cu
|
|
|
|
EXTENSION_MAPPING += cu=C++ inc=C++
|
|
|
|
ENABLE_PREPROCESSING = YES
|
|
|
|
JAVADOC_AUTOBRIEF = YES
|
|
|
|
WARN_IF_UNDOCUMENTED = NO
|
|
|
|
"""
|
|
|
|
|
|
|
|
exhale_args = {
|
2022-01-26 23:33:43 +03:00
|
|
|
"containmentFolder": "./api",
|
|
|
|
"rootFileName": "library_index.rst",
|
|
|
|
"rootFileTitle": "Library API",
|
|
|
|
"doxygenStripFromPath": "..",
|
|
|
|
"createTreeView": True,
|
|
|
|
"exhaleExecutesDoxygen": True,
|
|
|
|
"exhaleDoxygenStdin": doxygen_config.strip(),
|
2021-03-24 20:00:53 +03:00
|
|
|
}
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
primary_domain = "cpp"
|
|
|
|
highlight_language = "cpp"
|
2021-03-24 20:00:53 +03:00
|
|
|
|
|
|
|
# A trick to include markdown files from outside the source directory using
|
|
|
|
# 'mdinclude'. Warning: all other markdown files not included via 'mdinclude'
|
|
|
|
# will be rendered using recommonmark as recommended by Sphinx
|
|
|
|
from m2r import MdInclude
|
|
|
|
|
2022-01-26 23:33:43 +03:00
|
|
|
|
2021-03-24 20:00:53 +03:00
|
|
|
def setup(app):
|
|
|
|
# from m2r to make `mdinclude` work
|
2022-01-26 23:33:43 +03:00
|
|
|
app.add_config_value("no_underscore_emphasis", False, "env")
|
|
|
|
app.add_config_value("m2r_parse_relative_links", False, "env")
|
|
|
|
app.add_config_value("m2r_anonymous_references", False, "env")
|
|
|
|
app.add_config_value("m2r_disable_inline_math", False, "env")
|
|
|
|
app.add_directive("mdinclude", MdInclude)
|