Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up conf.py #1604

Merged
merged 1 commit into from
Jan 4, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 22 additions & 15 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
### https://www.sphinx-doc.org/en/master/usage/configuration.html ###

import abjad

### GENERAL SPHINX SETTINGS ###
### https://www.sphinx-doc.org/en/master/usage/configuration.html ###
autodoc_member_order = "groupwise"

copyright = "2008-2025, Trevor Bača & Joséphine Oberholtzer."

extensions = [
"abjad.ext.sphinx",
"sphinx.ext.autodoc",
Expand All @@ -19,6 +21,10 @@
"uqbar.sphinx.inheritance",
"uqbar.sphinx.style",
]

graphviz_dot_args = ["-s32"]
graphviz_output_format = "svg"

html_favicon = "_static/favicon.ico"
html_logo = "_static/abjad-logo.png"
html_show_copyright = False
Expand All @@ -32,9 +38,19 @@
# navigation_depth=1 makes sidebar completely flat;
# leave flat navigation in place forever:
"navigation_depth": 1,
"sticky_navigation": False,
"style_external_links": True,
"style_nav_header_background": "#eeccaa",
}

intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"sphinx": ("http://www.sphinx-doc.org/en/master/", None),
}

project = "Abjad"
pygments_style = "sphinx"

release = abjad.__version__
rst_epilog = """
.. _Bača: https://github.com/trevorbaca
Expand All @@ -50,11 +66,11 @@
rst_prolog = """
.. role:: author
"""

smartquotes = True
templates_path = ["_templates"]
version = abjad.__version__

### UQBAR ###
templates_path = ["_templates"]
todo_include_todos = True

uqbar_api_title = "Abjad API"
uqbar_api_source_paths = ["abjad"]
Expand Down Expand Up @@ -104,13 +120,4 @@
except ImportError:
pass

### OTHER EXTENSIONS ###

autodoc_member_order = "groupwise"
graphviz_dot_args = ["-s32"]
graphviz_output_format = "svg"
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"sphinx": ("http://www.sphinx-doc.org/en/master/", None),
}
todo_include_todos = True
version = abjad.__version__
Loading