Skip to content

Commit a3e9434

Browse files
committed
Merge pull request #2 from confluentinc/docs-rtd-theme
Use ReadTheDocs theme for building docs.
2 parents 343422a + b1c8562 commit a3e9434

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Run integration tests
3939

4040
Generate documentation
4141
======================
42+
Install sphinx and sphinx_rtd_theme packages and then:
4243

4344
make docs
4445

docs/conf.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -100,14 +100,16 @@
100100

101101
# -- Options for HTML output ----------------------------------------------
102102

103+
import sphinx_rtd_theme
104+
103105
# The theme to use for HTML and HTML Help pages. See the documentation for
104106
# a list of builtin themes.
105-
html_theme = 'default'
107+
html_theme = 'sphinx_rtd_theme'
106108

107109
# Theme options are theme-specific and customize the look and feel of a theme
108110
# further. For a list of options available for each theme, see the
109111
# documentation.
110-
#html_theme_options = {}
112+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
111113

112114
# Add any paths that contain custom themes here, relative to this directory.
113115
#html_theme_path = []

0 commit comments

Comments
 (0)