Skip to content
Merged
Show file tree
Hide file tree
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
31 changes: 15 additions & 16 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,19 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os

# import sys
# sys.path.insert(0, os.path.abspath('.'))


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

project = 'Open edX Aspects'
copyright = '2023, Open edX Community'
author = 'Open edX Community'
project = "Open edX Aspects"
copyright = "2023, Open edX Community"
author = "Open edX Community"

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


# -- General configuration ---------------------------------------------------
Expand All @@ -31,44 +32,42 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinxcontrib.contentui',
'sphinx_copybutton',
'sphinx.ext.graphviz',
'sphinxcontrib.mermaid',
"sphinx_copybutton",
"sphinx.ext.graphviz",
"sphinxcontrib.mermaid",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
language = "en"

# 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']
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 = 'alabaster'
html_theme = 'sphinx_book_theme'
# html_theme = 'alabaster'
html_theme = "sphinx_book_theme"

# 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']
html_static_path = ["_static"]


html_theme_options = {

"repository_url": "https://github.com/openedx/openedx-aspects",
"repository_branch": "main",
"path_to_docs": "docs/",
Expand Down Expand Up @@ -96,7 +95,7 @@
rel="license"
href="https://creativecommons.org/licenses/by-sa/4.0/"
>Creative Commons Attribution-ShareAlike 4.0 International License</a>.
"""
""",
}

# Note the logo won't show up properly yet because there is an upstream
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ dependencies = [
"sphinx-autobuild",
"sphinx-copybutton",
"sphinxcontrib-mermaid",
"sphinxcontrib-contentui",
]

[project.urls]
Expand Down
Loading