|
12 | 12 | # |
13 | 13 | import os |
14 | 14 | import sys |
15 | | -import sphinx_bootstrap_theme |
16 | | - |
17 | | -# sys.path.insert(0, os.path.abspath("../packages/python/plotly")) |
18 | | - |
19 | 15 |
|
20 | 16 | # -- Project information ----------------------------------------------------- |
21 | 17 |
|
22 | 18 | project = "" |
23 | | -copyright = "2022, Plotly" |
| 19 | +copyright = "2024, Plotly" |
24 | 20 | author = "Plotly" |
25 | 21 |
|
26 | 22 | # The short X.Y version |
|
63 | 59 | # The master toctree document. |
64 | 60 | master_doc = "index" |
65 | 61 |
|
66 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
67 | | -# for a list of supported languages. |
68 | | -# |
69 | | -# This is also used if you do content translation via gettext catalogs. |
70 | | -# Usually you set "language" from the command line for these cases. |
71 | | -language = None |
72 | | - |
73 | 62 | # List of patterns, relative to source directory, that match files and |
74 | 63 | # directories to ignore when looking for source files. |
75 | 64 | # This pattern also affects html_static_path and html_extra_path. |
|
85 | 74 | # The theme to use for HTML and HTML Help pages. See the documentation for |
86 | 75 | # a list of builtin themes. |
87 | 76 | # |
88 | | -html_theme = "bootstrap" |
89 | | -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() |
90 | 77 |
|
91 | | -html_logo = "_static/logo.png" |
| 78 | +html_theme = "sphinx_rtd_theme" |
| 79 | +html_logo = "_static/graphing_library.svg" |
| 80 | +html_show_sourcelink = False |
| 81 | + |
| 82 | +# -- If dark mode option wanted. Needs pip install sphinx-rtd-dark-mode |
| 83 | +# extensions.append("sphinx_rtd_dark_mode") |
| 84 | +# default_dark_mode = False |
| 85 | + |
92 | 86 | # Theme options are theme-specific and customize the look and feel of a theme |
93 | 87 | # further. For a list of options available for each theme, see the |
94 | 88 | # documentation. |
95 | 89 | # |
96 | 90 | html_theme_options = { |
97 | | - "analytics_id": "UA-39373211-1", # not supported by this theme |
98 | | - "bootswatch_theme": "flatly", |
99 | | - "source_link_position": "no", |
| 91 | + "analytics_id": "UA-39373211-1", # supported by rtd theme. Not by bootstrap? |
100 | 92 | } |
101 | 93 |
|
102 | 94 | # Add any paths that contain custom static files (such as style sheets) here, |
|
111 | 103 | # defined by theme itself. Builtin themes are using these templates by |
112 | 104 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', |
113 | 105 | # 'searchbox.html']``. |
114 | | -# |
115 | 106 | # html_sidebars = {} |
116 | 107 |
|
| 108 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars |
| 109 | +# This doesn't seem to get us anywhere |
| 110 | +# html_sidebars = { |
| 111 | +# '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'], |
| 112 | +# } |
| 113 | + |
117 | 114 | html_favicon = "_static/favicon.ico" |
118 | 115 |
|
119 | 116 | # -- Options for HTMLHelp output --------------------------------------------- |
|
171 | 168 | ) |
172 | 169 | ] |
173 | 170 |
|
174 | | - |
175 | 171 | # -- Options for Epub output ------------------------------------------------- |
176 | 172 |
|
177 | 173 | # Bibliographic Dublin Core info. |
|
202 | 198 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
203 | 199 | todo_include_todos = True |
204 | 200 |
|
205 | | - |
206 | | -def setup(app): |
207 | | - app.add_stylesheet("plotly-style.css") # also can be a full URL |
| 201 | +# Adding the bootstrap theme makes little difference - rules in the RTD theme are usually more specific |
| 202 | +html_css_files = [ |
| 203 | + # "https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css", |
| 204 | + "plotly-style.css" |
| 205 | +] |
0 commit comments