# Configuration file for the Sphinx documentation builder.
import os
import sys
# Need this so sphinx can find lumache.py. Change is .py files are elsewhere than root.
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('../../src'))
# -- Project information
project = 'Linguask'
copyright = '2022'
author = 'Multiple'
release = '0.1'
version = '0.1.0'
# -- General configuration
extensions = [
'sphinx.ext.duration',
'sphinx.ext.doctest',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
'autoapi.extension',
# 'sphinxcontrib.apidoc',
]
autoapi_type = 'python'
autoapi_dirs = ['../../src']
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'
# -- Options for EPUB output
epub_show_urls = 'footnote'
html_context = {
"display_github": True, # Integrate GitHub
"github_repo": "vitsyn-morgunov-and-nikulin/automatic-essay-evaluator", # Repo name
"github_version": "main", # Version
"conf_py_path": "docs/source/", # Path in the checkout to the docs root
}
# -- Options for HTML output -------------------------------------------------
html_short_title = "topobathy"
html_show_sourcelink = False
html_show_sphinx = True
html_show_copyright = True
# 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']
repository_url = "https://github.com/Vitsyn-Morgunov-and-Nikulin/automatic-essay-evaluator"
html_context = {
"menu_links": [
(
' Source Code',
repository_url,
),
(
' License',
f"{repository_url}/blob/main/LICENSE",
),
],
}