opentype-shaping-documents/conf.py at master · n8willis/opentype-shaping-documents · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import sys
from pathlib import Path

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'OpenType<br>Shaping<br>Documents'
copyright = '2022, Sponsored by YesLogic'
author = 'Sponsored by YesLogic'

version = "0.9"
release = "0.9alpha1"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

sys.path.append(str(Path('_ext').resolve()))

extensions = ['myst_parser', 'sphinx_external_toc', 'sphinx_inline_svg', 'shapingdocs_svg_color_toggles']

source_suffix = {'.md': 'markdown'}

templates_path = ['_templates']
exclude_patterns = ['_build', '_ext', 'test', 'Thumbs.db', '.DS_Store', 'BUILD.md', 'README.md', '**-image-generation-log.md', 'character-tables/README.md', 'images/images-index.md', 'images/README.md', 'notes/README.md'] # Eventually need to remove the links to image-generation-logs from the root README.md

root_doc = 'index' # Renamed to split GitHub README from production index

numfig = True
numfig_secnum_depth = 2

myst_heading_anchors = 6

# attrs_inline to specify HTML element attributes like img 'title' that are getting lost on build.
myst_enable_extensions = ['substitution', 'smartquotes', 'colon_fence', 'attrs_inline']

myst_substitutions = {
    'opentogglebutton': '<br><button onclick="toggleColor(',
    'closetogglebutton': ')">Substitution Toggle cluster colors</button><br>',
    'khmer_midsyllable_mark_table_workaround': 'Mid-syllable marks that must be tagged for sorting with above-base consonants',
}

external_toc_path = "_toc.yml"

# Starting with sphinx_external_toc 1.1.0, "multitoc numbering" is activated
# by this configuration key and the standalone sphinx_multitoc_numbering
# extension is not required
use_multitoc_numbering = True

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']
html_js_files = ['toggleSvgColors.js']
html_sidebars = {
    '**': [
        'about.html',
        'static_nav.html',
#        'navigation.html', # Replacing default navigation with static version above
        'searchbox.html',
        'sourcelink.html',
        ]
    }
html_theme_options = {
    'page_width': '1200px',
    'sidebar_width': '300px',
    'github_user': 'n8willis',
    'github_repo': 'opentype-shaping-documents',
    'font_family': 'Source\ Serif\ 4',
    'head_font_family': 'Source\ Serif\ 4',
    'caption_font_family': 'Source\ Serif\ 4',
    'code_font_family': 'Source\ Code\ Pro',
    'github_button': True,
    'github_type': 'watch',
    'github_count': True,
    'extra_nav_links': {
        'GitHub issues': 'https://github.com/n8willis/opentype-shaping-documents/issues',
        'Build process': 'https://github.com/n8willis/opentype-shaping-documents/blob/master/BUILD.md', # Fix the directory path after PR merge; Add contributor-guide link
        }
}