|
13 | 13 | # All configuration values have a default; values that are commented out |
14 | 14 | # serve to show the default. |
15 | 15 |
|
16 | | -import sys |
17 | 16 | import os |
18 | 17 |
|
19 | 18 | # If extensions (or modules to document with autodoc) are in another directory, |
|
36 | 35 | 'sphinx.ext.viewcode', |
37 | 36 | 'sphinx.ext.autosummary', |
38 | 37 | 'sphinx.ext.extlinks', |
39 | | - 'numpydoc', |
| 38 | + 'sphinx.ext.napoleon', |
40 | 39 | ] |
41 | 40 |
|
42 | 41 | # Add any paths that contain templates here, relative to this directory. |
|
68 | 67 | # The full version, including alpha/beta/rc tags. |
69 | 68 | release = version |
70 | 69 |
|
71 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
72 | | -# for a list of supported languages. |
73 | | -# |
74 | | -# This is also used if you do content translation via gettext catalogs. |
75 | | -# Usually you set "language" from the command line for these cases. |
76 | | -language = None |
77 | | - |
78 | 70 | # There are two options for replacing |today|: either, you set today to some |
79 | 71 | # non-false value, then it is used: |
80 | 72 | #today = '' |
|
113 | 105 | todo_include_todos = False |
114 | 106 |
|
115 | 107 | extlinks = { |
116 | | - "pr": ("https://github.com/fsspec/s3fs/pull/%s", "PR #"), |
| 108 | + "pr": ("https://github.com/fsspec/s3fs/pull/%s", "PR #%s"), |
117 | 109 | } |
118 | 110 |
|
119 | 111 |
|
120 | 112 | # -- Options for HTML output ---------------------------------------------- |
121 | 113 |
|
122 | | -# Taken from docs.readthedocs.io: |
123 | | -# on_rtd is whether we are on readthedocs.io |
124 | | -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' |
125 | | - |
126 | | -if not on_rtd: # only import and set the theme if we're building docs locally |
127 | | - import sphinx_rtd_theme |
128 | | - html_theme = 'sphinx_rtd_theme' |
129 | | - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 114 | +html_theme = 'sphinx_rtd_theme' |
130 | 115 |
|
131 | 116 | # Theme options are theme-specific and customize the look and feel of a theme |
132 | 117 | # further. For a list of options available for each theme, see the |
|
157 | 142 | # so a file named "default.css" will overwrite the builtin "default.css". |
158 | 143 | html_static_path = ['_static'] |
159 | 144 |
|
| 145 | +# Custom CSS file to override read the docs default CSS. |
| 146 | +# Contains workaround for issue #790. |
| 147 | +html_css_files = ["custom.css"] |
| 148 | + |
160 | 149 | # Add any extra paths that contain custom files (such as robots.txt or |
161 | 150 | # .htaccess) here, relative to this directory. These files are copied |
162 | 151 | # directly to the root of the documentation. |
|
278 | 267 | #man_show_urls = False |
279 | 268 |
|
280 | 269 |
|
| 270 | + |
281 | 271 | # -- Options for Texinfo output ------------------------------------------- |
282 | 272 |
|
283 | 273 | # Grouping the document tree into Texinfo files. List of tuples |
|
0 commit comments