mirror of
https://github.com/browsermt/bergamot-translator.git
synced 2024-09-11 13:46:12 +03:00
c0f311a8c0
Imports python bindings and associated sources incubated in https://github.com/jerinphilip/lemonade to bergamot-translator. Adds a pybind11 dependency for python bindings. Following the import, the python build is integrated into the existing CMake based build system here. There is a command-line application provided through python which provides the ability to fetch and prepare models from model-repositories (like browsermt/students or OPUS). Wheels built for a few common operating systems are provided via GitHub releases through automated actions configured to run at tagged semantic versions and pushes to main. The documentation for python is also integrated into our existing documentation setup. Previous documentation GitHub action is now configured to run behind python builds in Ubuntu 18.04 Python3.7, in order to pick up the packaged as a wheel bergamot module and the sphinx documentation using the python module. Formatting checks of black, isort with profile black and a pytype type checker is configured for the python component residing in this repository.
127 lines
3.9 KiB
Python
127 lines
3.9 KiB
Python
# 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 --------------------------------------------------------------
|
|
|
|
import datetime
|
|
|
|
# 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
|
|
|
|
sys.path.insert(0, os.path.abspath("."))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "Bergamot Translator"
|
|
copyright = "2021-2022 Bergamot Translator Team"
|
|
author = "Bergamot Translator Team"
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
# TODO: add GitHub commit hash to the version
|
|
version_file = os.path.join(
|
|
os.path.dirname(os.path.dirname(__file__)), "BERGAMOT_VERSION"
|
|
)
|
|
with open(os.path.abspath(version_file)) as f:
|
|
version = f.read().strip()
|
|
release = version + " " + str(datetime.date.today())
|
|
|
|
|
|
# -- 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 = [
|
|
"sphinx.ext.mathjax",
|
|
"sphinx.ext.todo",
|
|
"breathe",
|
|
"exhale",
|
|
"recommonmark",
|
|
"sphinx.ext.autodoc",
|
|
"sphinxarg.ext",
|
|
]
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# 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 = [
|
|
"build",
|
|
"doxygen",
|
|
"venv",
|
|
"README.md",
|
|
]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
htmlhelp_basename = "bergamot-translator"
|
|
|
|
# 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".
|
|
html_static_path = ["_static"]
|
|
html_css_files = ["css/custom.css"]
|
|
|
|
# The base URL which points to the root of the HTML documentation
|
|
html_baseurl = "https://browser.mt/docs"
|
|
|
|
|
|
# -- Extension configuration -------------------------------------------------
|
|
|
|
breathe_projects = {"bergamot-translator": "./doxygen/xml"}
|
|
breathe_default_project = "bergamot-translator"
|
|
|
|
doxygen_config = """
|
|
INPUT = ../src ../app
|
|
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 = {
|
|
"containmentFolder": "./api",
|
|
"rootFileName": "library_index.rst",
|
|
"rootFileTitle": "Library API",
|
|
"doxygenStripFromPath": "..",
|
|
"createTreeView": True,
|
|
"exhaleExecutesDoxygen": True,
|
|
"exhaleDoxygenStdin": doxygen_config.strip(),
|
|
}
|
|
|
|
primary_domain = "cpp"
|
|
highlight_language = "cpp"
|
|
|
|
# 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
|
|
|
|
|
|
def setup(app):
|
|
# from m2r to make `mdinclude` work
|
|
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)
|