diff options
author | David Robillard <d@drobilla.net> | 2020-12-21 18:13:18 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-12-21 19:35:11 +0100 |
commit | a392684c178b0f4bccdec06116048213bae1b491 (patch) | |
tree | 48ca5569c155623a7983e48f302796129737b861 /doc/conf.py.in | |
parent | 4c3cea9274a8596197ae73a97eb31187cc18770c (diff) | |
download | suil-a392684c178b0f4bccdec06116048213bae1b491.tar.gz suil-a392684c178b0f4bccdec06116048213bae1b491.tar.bz2 suil-a392684c178b0f4bccdec06116048213bae1b491.zip |
Generate documentation with Sphinx
Diffstat (limited to 'doc/conf.py.in')
-rw-r--r-- | doc/conf.py.in | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/conf.py.in b/doc/conf.py.in new file mode 100644 index 0000000..cf81c5d --- /dev/null +++ b/doc/conf.py.in @@ -0,0 +1,69 @@ +# Project information + +project = "Suil" +copyright = "2020, David Robillard" +author = "David Robillard" +release = "@SUIL_VERSION@" + +# General configuration + +language = "en" + +extensions = [ + # 'sphinx_rtd_theme', +] + +# Enable nitpicky mode to get warnings about broken links +# Unfortunately this means we need to explicitly ignore everything external +nitpicky = True +_opaque = [ + "LV2_Feature", + "SuilHostImpl", + "SuilInstanceImpl", + "uint32_t", +] + +nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque)) + +templates_path = ["_templates"] + +pygments_style = "friendly" + +# HTML output + +exclude_patterns = ["xml"] +html_static_path = ["_static"] + +html_theme = "alabaster" +# html_theme = "sphinx_rtd_theme" + +if html_theme == "alabaster": + + html_theme_options = { + "description": "A library for loading LV2 plugin UIs", + "donate_url": "http://drobilla.net/pages/donate.html", + # "github_repo": "suil", + # "github_user": "lv2", + # "logo": "suil.svg", + "logo_name": True, + "logo_text_align": "center", + "page_width": "80em - 20em", + "sidebar_width": "20em", + } + + html_sidebars = { + "**": [ + "about.html", + "localtoc.html", + "donate.html", + ] + } + +elif html_theme == "sphinx_rtd_theme": + + html_theme_options = { + "sticky_navigation": False, + "collapse_navigation": False, + "navigation_depth": 4, + "display_version": True, + } |