Artifact
8c414feb18cb46eeb71c51ca435ac28605ea1a2f76b41796033a2ce908c932e2:
- File
source/conf.py
— part of check-in
[fa4745a0a7]
at
2021-11-08 06:21:09
on branch trunk
— Added cue Changed Support link Working example for p5
Added dsl for tracking
Added autocommit
Various Fixes for Save Improve Docs and Bookmarks WebGL Demo
(user:
dev
size: 2627)
0000: 23 20 43 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 # Configuration
0010: 66 69 6c 65 20 66 6f 72 20 74 68 65 20 53 70 68 file for the Sph
0020: 69 6e 78 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f inx documentatio
0030: 6e 20 62 75 69 6c 64 65 72 2e 0a 23 0a 23 20 54 n builder..#.# T
0040: 68 69 73 20 66 69 6c 65 20 6f 6e 6c 79 20 63 6f his file only co
0050: 6e 74 61 69 6e 73 20 61 20 73 65 6c 65 63 74 69 ntains a selecti
0060: 6f 6e 20 6f 66 20 74 68 65 20 6d 6f 73 74 20 63 on of the most c
0070: 6f 6d 6d 6f 6e 20 6f 70 74 69 6f 6e 73 2e 20 46 ommon options. F
0080: 6f 72 20 61 20 66 75 6c 6c 0a 23 20 6c 69 73 74 or a full.# list
0090: 20 73 65 65 20 74 68 65 20 64 6f 63 75 6d 65 6e see the documen
00a0: 74 61 74 69 6f 6e 3a 0a 23 20 68 74 74 70 73 3a tation:.# https:
00b0: 2f 2f 77 77 77 2e 73 70 68 69 6e 78 2d 64 6f 63 //www.sphinx-doc
00c0: 2e 6f 72 67 2f 65 6e 2f 6d 61 73 74 65 72 2f 75 .org/en/master/u
00d0: 73 61 67 65 2f 63 6f 6e 66 69 67 75 72 61 74 69 sage/configurati
00e0: 6f 6e 2e 68 74 6d 6c 0a 0a 23 20 2d 2d 20 50 61 on.html..# -- Pa
00f0: 74 68 20 73 65 74 75 70 20 2d 2d 2d 2d 2d 2d 2d th setup -------
0100: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0110: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0120: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0130: 2d 2d 2d 2d 2d 2d 2d 0a 0a 23 20 49 66 20 65 78 -------..# If ex
0140: 74 65 6e 73 69 6f 6e 73 20 28 6f 72 20 6d 6f 64 tensions (or mod
0150: 75 6c 65 73 20 74 6f 20 64 6f 63 75 6d 65 6e 74 ules to document
0160: 20 77 69 74 68 20 61 75 74 6f 64 6f 63 29 20 61 with autodoc) a
0170: 72 65 20 69 6e 20 61 6e 6f 74 68 65 72 20 64 69 re in another di
0180: 72 65 63 74 6f 72 79 2c 0a 23 20 61 64 64 20 74 rectory,.# add t
0190: 68 65 73 65 20 64 69 72 65 63 74 6f 72 69 65 73 hese directories
01a0: 20 74 6f 20 73 79 73 2e 70 61 74 68 20 68 65 72 to sys.path her
01b0: 65 2e 20 49 66 20 74 68 65 20 64 69 72 65 63 74 e. If the direct
01c0: 6f 72 79 20 69 73 20 72 65 6c 61 74 69 76 65 20 ory is relative
01d0: 74 6f 20 74 68 65 0a 23 20 64 6f 63 75 6d 65 6e to the.# documen
01e0: 74 61 74 69 6f 6e 20 72 6f 6f 74 2c 20 75 73 65 tation root, use
01f0: 20 6f 73 2e 70 61 74 68 2e 61 62 73 70 61 74 68 os.path.abspath
0200: 20 74 6f 20 6d 61 6b 65 20 69 74 20 61 62 73 6f to make it abso
0210: 6c 75 74 65 2c 20 6c 69 6b 65 20 73 68 6f 77 6e lute, like shown
0220: 20 68 65 72 65 2e 0a 23 0a 23 20 69 6d 70 6f 72 here..#.# impor
0230: 74 20 6f 73 0a 23 20 69 6d 70 6f 72 74 20 73 79 t os.# import sy
0240: 73 0a 23 20 73 79 73 2e 70 61 74 68 2e 69 6e 73 s.# sys.path.ins
0250: 65 72 74 28 30 2c 20 6f 73 2e 70 61 74 68 2e 61 ert(0, os.path.a
0260: 62 73 70 61 74 68 28 27 2e 27 29 29 0a 0a 0a 23 bspath('.'))...#
0270: 20 2d 2d 20 50 72 6f 6a 65 63 74 20 69 6e 66 6f -- Project info
0280: 72 6d 61 74 69 6f 6e 20 2d 2d 2d 2d 2d 2d 2d 2d rmation --------
0290: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
02a0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
02b0: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 0a 0a 70 -------------..p
02c0: 72 6f 6a 65 63 74 20 3d 20 27 42 69 74 72 68 79 roject = 'Bitrhy
02d0: 74 68 6d 27 0a 63 6f 70 79 72 69 67 68 74 20 3d thm'.copyright =
02e0: 20 27 28 63 29 20 58 79 7a 7a 79 20 41 70 70 73 '(c) Xyzzy Apps
02f0: 2c 20 32 30 32 31 27 0a 61 75 74 68 6f 72 20 3d , 2021'.author =
0300: 20 27 58 79 7a 7a 79 20 41 70 70 73 27 0a 6d 61 'Xyzzy Apps'.ma
0310: 73 74 65 72 5f 64 6f 63 20 3d 20 22 69 6e 64 65 ster_doc = "inde
0320: 78 22 0a 0a 0a 23 20 2d 2d 20 47 65 6e 65 72 61 x"...# -- Genera
0330: 6c 20 63 6f 6e 66 69 67 75 72 61 74 69 6f 6e 20 l configuration
0340: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0350: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0360: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0370: 2d 2d 2d 0a 0a 23 20 41 64 64 20 61 6e 79 20 53 ---..# Add any S
0380: 70 68 69 6e 78 20 65 78 74 65 6e 73 69 6f 6e 20 phinx extension
0390: 6d 6f 64 75 6c 65 20 6e 61 6d 65 73 20 68 65 72 module names her
03a0: 65 2c 20 61 73 20 73 74 72 69 6e 67 73 2e 20 54 e, as strings. T
03b0: 68 65 79 20 63 61 6e 20 62 65 0a 23 20 65 78 74 hey can be.# ext
03c0: 65 6e 73 69 6f 6e 73 20 63 6f 6d 69 6e 67 20 77 ensions coming w
03d0: 69 74 68 20 53 70 68 69 6e 78 20 28 6e 61 6d 65 ith Sphinx (name
03e0: 64 20 27 73 70 68 69 6e 78 2e 65 78 74 2e 2a 27 d 'sphinx.ext.*'
03f0: 29 20 6f 72 20 79 6f 75 72 20 63 75 73 74 6f 6d ) or your custom
0400: 0a 23 20 6f 6e 65 73 2e 0a 65 78 74 65 6e 73 69 .# ones..extensi
0410: 6f 6e 73 20 3d 20 5b 27 6d 79 73 74 5f 70 61 72 ons = ['myst_par
0420: 73 65 72 27 2c 20 27 73 70 68 69 6e 78 2e 65 78 ser', 'sphinx.ex
0430: 74 2e 74 6f 64 6f 27 5d 0a 74 6f 64 6f 5f 69 6e t.todo'].todo_in
0440: 63 6c 75 64 65 5f 74 6f 64 6f 73 20 3d 20 54 72 clude_todos = Tr
0450: 75 65 0a 0a 73 6f 75 72 63 65 5f 73 75 66 66 69 ue..source_suffi
0460: 78 20 3d 20 5b 27 2e 72 73 74 27 2c 20 27 2e 6d x = ['.rst', '.m
0470: 64 27 5d 0a 23 20 41 64 64 20 61 6e 79 20 70 61 d'].# Add any pa
0480: 74 68 73 20 74 68 61 74 20 63 6f 6e 74 61 69 6e ths that contain
0490: 20 74 65 6d 70 6c 61 74 65 73 20 68 65 72 65 2c templates here,
04a0: 20 72 65 6c 61 74 69 76 65 20 74 6f 20 74 68 69 relative to thi
04b0: 73 20 64 69 72 65 63 74 6f 72 79 2e 0a 74 65 6d s directory..tem
04c0: 70 6c 61 74 65 73 5f 70 61 74 68 20 3d 20 5b 27 plates_path = ['
04d0: 5f 74 65 6d 70 6c 61 74 65 73 27 5d 0a 0a 23 20 _templates']..#
04e0: 4c 69 73 74 20 6f 66 20 70 61 74 74 65 72 6e 73 List of patterns
04f0: 2c 20 72 65 6c 61 74 69 76 65 20 74 6f 20 73 6f , relative to so
0500: 75 72 63 65 20 64 69 72 65 63 74 6f 72 79 2c 20 urce directory,
0510: 74 68 61 74 20 6d 61 74 63 68 20 66 69 6c 65 73 that match files
0520: 20 61 6e 64 0a 23 20 64 69 72 65 63 74 6f 72 69 and.# directori
0530: 65 73 20 74 6f 20 69 67 6e 6f 72 65 20 77 68 65 es to ignore whe
0540: 6e 20 6c 6f 6f 6b 69 6e 67 20 66 6f 72 20 73 6f n looking for so
0550: 75 72 63 65 20 66 69 6c 65 73 2e 0a 23 20 54 68 urce files..# Th
0560: 69 73 20 70 61 74 74 65 72 6e 20 61 6c 73 6f 20 is pattern also
0570: 61 66 66 65 63 74 73 20 68 74 6d 6c 5f 73 74 61 affects html_sta
0580: 74 69 63 5f 70 61 74 68 20 61 6e 64 20 68 74 6d tic_path and htm
0590: 6c 5f 65 78 74 72 61 5f 70 61 74 68 2e 0a 65 78 l_extra_path..ex
05a0: 63 6c 75 64 65 5f 70 61 74 74 65 72 6e 73 20 3d clude_patterns =
05b0: 20 5b 27 5f 62 75 69 6c 64 27 2c 20 27 54 68 75 ['_build', 'Thu
05c0: 6d 62 73 2e 64 62 27 2c 20 27 2e 44 53 5f 53 74 mbs.db', '.DS_St
05d0: 6f 72 65 27 5d 0a 0a 0a 23 20 2d 2d 20 4f 70 74 ore']...# -- Opt
05e0: 69 6f 6e 73 20 66 6f 72 20 48 54 4d 4c 20 6f 75 ions for HTML ou
05f0: 74 70 75 74 20 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d tput -----------
0600: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0610: 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d 2d ----------------
0620: 2d 2d 2d 2d 2d 2d 0a 0a 23 20 54 68 65 20 74 68 ------..# The th
0630: 65 6d 65 20 74 6f 20 75 73 65 20 66 6f 72 20 48 eme to use for H
0640: 54 4d 4c 20 61 6e 64 20 48 54 4d 4c 20 48 65 6c TML and HTML Hel
0650: 70 20 70 61 67 65 73 2e 20 20 53 65 65 20 74 68 p pages. See th
0660: 65 20 64 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 20 e documentation
0670: 66 6f 72 0a 23 20 61 20 6c 69 73 74 20 6f 66 20 for.# a list of
0680: 62 75 69 6c 74 69 6e 20 74 68 65 6d 65 73 2e 0a builtin themes..
0690: 23 0a 68 74 6d 6c 5f 74 68 65 6d 65 20 3d 20 27 #.html_theme = '
06a0: 73 70 68 69 6e 78 5f 62 6f 6f 6b 5f 74 68 65 6d sphinx_book_them
06b0: 65 27 0a 68 74 6d 6c 5f 74 69 74 6c 65 20 3d 20 e'.html_title =
06c0: 22 42 69 74 72 68 79 74 68 6d 27 73 20 6c 69 74 "Bitrhythm's lit
06d0: 65 72 61 74 65 20 64 6f 63 75 6d 65 6e 74 61 74 erate documentat
06e0: 69 6f 6e 22 0a 0a 68 74 6d 6c 5f 74 68 65 6d 65 ion"..html_theme
06f0: 5f 6f 70 74 69 6f 6e 73 20 3d 20 7b 0a 20 20 20 _options = {.
0700: 20 22 75 73 65 5f 66 75 6c 6c 73 63 72 65 65 6e "use_fullscreen
0710: 5f 62 75 74 74 6f 6e 22 3a 20 54 72 75 65 2c 0a _button": True,.
0720: 20 20 20 20 22 73 69 6e 67 6c 65 5f 70 61 67 65 "single_page
0730: 22 3a 20 46 61 6c 73 65 2c 0a 20 20 20 20 22 75 ": False,. "u
0740: 73 65 5f 64 6f 77 6e 6c 6f 61 64 5f 62 75 74 74 se_download_butt
0750: 6f 6e 22 3a 20 46 61 6c 73 65 2c 0a 20 20 20 20 on": False,.
0760: 22 68 6f 6d 65 5f 70 61 67 65 5f 69 6e 5f 74 6f "home_page_in_to
0770: 63 22 3a 20 46 61 6c 73 65 2c 0a 20 20 20 20 22 c": False,. "
0780: 65 78 74 72 61 5f 6e 61 76 62 61 72 22 3a 20 22 extra_navbar": "
0790: 22 22 0a 3c 61 20 74 61 72 67 65 74 3d 22 5f 62 "".<a target="_b
07a0: 6c 61 6e 6b 22 20 68 72 65 66 3d 22 2f 22 3e 42 lank" href="/">B
07b0: 69 74 72 68 79 74 68 6d 20 41 70 70 20 48 6f 6d itrhythm App Hom
07c0: 65 3c 2f 61 3e 3c 62 72 3e 0a 3c 61 20 74 61 72 e</a><br>.<a tar
07d0: 67 65 74 3d 22 5f 62 6c 61 6e 6b 22 20 68 72 65 get="_blank" hre
07e0: 66 3d 22 68 74 74 70 73 3a 2f 2f 78 79 7a 7a 79 f="https://xyzzy
07f0: 61 70 70 73 2e 6c 69 6e 6b 22 3e 58 79 7a 7a 79 apps.link">Xyzzy
0800: 20 41 70 70 73 20 48 6f 6d 65 3c 2f 61 3e 3c 62 Apps Home</a><b
0810: 72 3e 0a 3c 70 20 63 6c 61 73 73 3d 27 63 75 73 r>.<p class='cus
0820: 74 6f 6d 2d 6e 61 76 2d 66 6f 6f 74 65 72 27 3e tom-nav-footer'>
0830: 28 63 29 20 58 79 7a 7a 79 20 41 70 70 73 2c 20 (c) Xyzzy Apps,
0840: 32 30 32 31 3c 2f 70 3e 0a 22 22 22 0a 7d 0a 0a 2021</p>.""".}..
0850: 68 74 6d 6c 5f 73 69 64 65 62 61 72 73 20 3d 20 html_sidebars =
0860: 7b 0a 20 20 20 22 2a 2a 22 3a 20 5b 22 73 69 64 {. "**": ["sid
0870: 65 62 61 72 2d 6c 6f 67 6f 2e 68 74 6d 6c 22 2c ebar-logo.html",
0880: 20 22 73 62 74 2d 73 69 64 65 62 61 72 2d 6e 61 "sbt-sidebar-na
0890: 76 2e 68 74 6d 6c 22 2c 20 22 73 62 74 2d 73 69 v.html", "sbt-si
08a0: 64 65 62 61 72 2d 66 6f 6f 74 65 72 2e 68 74 6d debar-footer.htm
08b0: 6c 22 5d 0a 7d 0a 0a 68 74 6d 6c 5f 73 68 6f 77 l"].}..html_show
08c0: 5f 73 70 68 69 6e 78 20 3d 20 46 61 6c 73 65 0a _sphinx = False.
08d0: 68 74 6d 6c 5f 73 68 6f 77 5f 73 6f 75 72 63 65 html_show_source
08e0: 6c 69 6e 6b 20 3d 20 46 61 6c 73 65 0a 0a 23 20 link = False..#
08f0: 41 64 64 20 61 6e 79 20 70 61 74 68 73 20 74 68 Add any paths th
0900: 61 74 20 63 6f 6e 74 61 69 6e 20 63 75 73 74 6f at contain custo
0910: 6d 20 73 74 61 74 69 63 20 66 69 6c 65 73 20 28 m static files (
0920: 73 75 63 68 20 61 73 20 73 74 79 6c 65 20 73 68 such as style sh
0930: 65 65 74 73 29 20 68 65 72 65 2c 0a 23 20 72 65 eets) here,.# re
0940: 6c 61 74 69 76 65 20 74 6f 20 74 68 69 73 20 64 lative to this d
0950: 69 72 65 63 74 6f 72 79 2e 20 54 68 65 79 20 61 irectory. They a
0960: 72 65 20 63 6f 70 69 65 64 20 61 66 74 65 72 20 re copied after
0970: 74 68 65 20 62 75 69 6c 74 69 6e 20 73 74 61 74 the builtin stat
0980: 69 63 20 66 69 6c 65 73 2c 0a 23 20 73 6f 20 61 ic files,.# so a
0990: 20 66 69 6c 65 20 6e 61 6d 65 64 20 22 64 65 66 file named "def
09a0: 61 75 6c 74 2e 63 73 73 22 20 77 69 6c 6c 20 6f ault.css" will o
09b0: 76 65 72 77 72 69 74 65 20 74 68 65 20 62 75 69 verwrite the bui
09c0: 6c 74 69 6e 20 22 64 65 66 61 75 6c 74 2e 63 73 ltin "default.cs
09d0: 73 22 2e 0a 68 74 6d 6c 5f 73 74 61 74 69 63 5f s"..html_static_
09e0: 70 61 74 68 20 3d 20 5b 27 5f 73 74 61 74 69 63 path = ['_static
09f0: 27 5d 0a 68 74 6d 6c 5f 6a 73 5f 66 69 6c 65 73 '].html_js_files
0a00: 20 3d 20 5b 0a 20 20 20 20 20 20 20 20 27 61 6e = [. 'an
0a10: 61 6c 79 74 69 63 73 2e 6a 73 27 2c 0a 20 20 20 alytics.js',.
0a20: 20 5d 0a 68 74 6d 6c 5f 63 73 73 5f 66 69 6c 65 ].html_css_file
0a30: 73 20 3d 20 5b 22 63 75 73 74 6f 6d 2e 63 73 73 s = ["custom.css
0a40: 22 5d 0a "].