Skip to content
Open
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
36 changes: 23 additions & 13 deletions documentation/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import sphinx_bootstrap_theme
import sys
import os

Expand All @@ -33,7 +32,6 @@
"brokenrole",
"relativelink",
"rubydomain",
"sphinxcontrib.jquery", # for bootstrap theme
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -117,23 +115,38 @@

# -- Options for HTML output ---------------------------------------------------

html_logo = "../FDB_logo.svg"

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "bootstrap"
html_theme = "shibuya"

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
# html_theme_path = []

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"globaltoc_depth": 2,
"globaltoc_includehidden": "true",
"navbar_links": [
("Site Map", "contents"),
"accent_color": "blue",
"discussion_url": "https://forums.foundationdb.org/",
"github_url": "https://github.com/apple/foundationdb",
"nav_links": [
{
"title": "Site Map",
"url": "contents"
},
],
"source_link_position": "footer",
}

# A dictionary of values to pass into the template engine's context for all pages.
html_context = {
# Edit this page
"source_type": "github",
"source_user": "apple",
"source_repo": "foundationdb",
"source_version": "main",
"source_docs_path": "/documentation/sphinx/source/",
}

# Create table of contents entries for domain objects
Expand Down Expand Up @@ -165,10 +178,7 @@
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
"**": ["localtoc.html"],
"contents": [],
}
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
8 changes: 2 additions & 6 deletions documentation/sphinx/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
Sphinx==6.2.1
sphinx-bootstrap-theme==0.8.1
sphinxcontrib-jquery==4.1
docutils==0.19
Jinja2==3.1.6
urllib3<3
sphinx
shibuya
Loading