conf.py

# 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 --------------------------------------------------------------

# 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('.'))
from better import better_theme_path
html_theme_path = [better_theme_path]

# -- Project information -----------------------------------------------------

project = 'EOA Project Documentation'
copyright = '2020, Max Planck Institute for the History of Science'
author = 'Klaus Thoden'

# The full version, including alpha/beta/rc tags
release = '1.0'


# -- 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.autosectionlabel',
    'sphinx.ext.intersphinx'
]
autosectionlabel_prefix_document = True

# 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', 'Thumbs.db', '.DS_Store']


# -- 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 = 'better'
# html_theme = 'classic'

# 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']

DOC_URL = "https://docs.edition-open-access.de"
# DOC_URL = "http://localhost:7999"

# mapping to other documentations
intersphinx_mapping = {
    # 'eoaskripts': (f'{DOC_URL}/EOASkripts', None),
    'metadator': (f'{DOC_URL}/eoa_metadator', None),
    'authors': (f'{DOC_URL}/django-eoaauthors', None),
    'ckeditor': (f'{DOC_URL}/django-eoackeditor', None),
    'cmscomponents': (f'{DOC_URL}/django-eoacmscomponents', None),
    'forthcoming': (f'{DOC_URL}/django-eoaforthcoming', None),
    'projects': (f'{DOC_URL}/django-eoaprojects', None),
    'publications': (f'{DOC_URL}/django-eoapublications', None),
    'series': (f'{DOC_URL}/django-eoaseries', None),
    'opds': (f'{DOC_URL}/django-opds', None),
    'eoa15': (f'{DOC_URL}/eoa-1.5', None),
    'makestatic': (f'{DOC_URL}/eoa_makestatic', None),
    'publicationmodel': (f'{DOC_URL}/eoa-publication-model', None),
    'utilities': (f'{DOC_URL}/eoa-utilities', None),
    'xmlmind': (f'{DOC_URL}/eoa-xmlmind', None),
    'eoa2': (f'{DOC_URL}/eoa2-xmldb', None),
    'eoa-exist-app': (f'{DOC_URL}/eoa-exist-app', None),
    'hieoa': (f'{DOC_URL}/hyperimage_eoa', None),
    'hiscripts': (f'{DOC_URL}/hyperimage_scripts', None),
    'webplat': (f'{DOC_URL}/webdesign_platform', None),
}