Skip to content

Commit b5099bd

Browse files
Merge pull request #411 from kstrenkova/new-python-version-in-docs
Change the documentation theme
2 parents a822e2c + 4750fda commit b5099bd

2 files changed

Lines changed: 22 additions & 16 deletions

File tree

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
ansible-core>=2.14.6
22
sphinx>=6.2.1 # BSD
33
sphinx-autobuild>=2021.3.1
4-
sphinx-material
4+
furo
55
doc8>=0.8.1 # Apache-2.0
66
sphinxemoji
77
myst-parser
8+
sphinx-copybutton
89
sphinx-design

docs/source/conf.py

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"sphinx.ext.todo",
3131
"sphinx.ext.viewcode",
3232
"sphinxemoji.sphinxemoji",
33+
"sphinx_copybutton",
3334
"sphinx_design"
3435
]
3536

@@ -89,31 +90,35 @@
8990

9091
# The theme to use for HTML and HTML Help pages. See the documentation for
9192
# a list of builtin themes.
92-
# html_logo = "images/logo_cifmw_200.png"
93-
html_theme = "sphinx_material"
93+
html_theme = "furo"
9494

9595
html_show_sourcelink = True
9696
html_sidebars = {
97-
"**": ["globaltoc.html", "localtoc.html"]
97+
"**": [
98+
"sidebar/brand.html",
99+
"sidebar/search.html",
100+
"sidebar/scroll-start.html",
101+
"sidebar/navigation.html",
102+
"sidebar/scroll-end.html",
103+
]
98104
}
99105

106+
html_title = "test-operator"
107+
100108
# Theme options are theme-specific and customize the look and feel of a theme
101109
# further. For a list of options available for each theme, see the
102110
# documentation.
103111
#
104112
html_theme_options = {
105-
"base_url": "https://github.com/openstack-k8s-operators/test-operator/",
106-
"repo_url": "https://github.com/openstack-k8s-operators/test-operator/",
107-
"nav_title": "test-operator",
108-
"repo_name": "test-operator",
109-
"repo_type": "github",
110-
"globaltoc_depth": 2,
111-
"color_primary": "blue-grey",
112-
"color_accent": "cyan",
113-
"touch_icon": "images/openstack-logo.png",
114-
"theme_color": "#2196f3",
115-
"master_doc": False,
116-
"table_classes": ["plain"],
113+
"source_repository": "https://github.com/openstack-k8s-operators/test-operator/",
114+
"source_branch": "main",
115+
"source_directory": "docs/source/",
116+
"light_css_variables": {
117+
"color-link-underline": "transparent",
118+
},
119+
"dark_css_variables": {
120+
"color-link-underline": "transparent",
121+
}
117122
}
118123

119124
# -- Options for HTMLHelp output ------------------------------------------

0 commit comments

Comments
 (0)