|
53 | 53 | ), |
54 | 54 | } |
55 | 55 |
|
| 56 | + |
56 | 57 | # Add any paths that contain templates here, relative to this directory. |
57 | 58 | templates_path = ["_templates"] |
58 | | -# templates_path = ['../_templates'] |
59 | 59 |
|
60 | 60 | # List of patterns, relative to source directory, that match files and |
61 | 61 | # directories to ignore when looking for source files. |
|
70 | 70 | # |
71 | 71 | html_theme = "sphinx_rtd_theme" |
72 | 72 |
|
73 | | -# This adds to the levels displayed in the sidebar but the indent is wrong and expand/collapse doesn't work for the additional nodes. |
74 | | -# It's a known issue: see https://stackoverflow.com/questions/14477396/how-to-expand-all-the-subsections-on-the-sidebar-toctree-in-sphinx and https://github.com/readthedocs/sphinx_rtd_theme/issues/455 |
75 | | -# html_theme_options = { |
76 | | -# 'navigation_depth': 6, |
77 | | -# } |
78 | | - |
79 | | -html_theme_options = { |
80 | | - "canonical_url": "", |
81 | | - "analytics_id": "UA-XXXXXXX-1", |
82 | | - "logo_only": False, |
83 | | - # "display_version": True, |
84 | | - # 'prev_next_buttons_location': 'bottom', |
85 | | - # 'prev_next_buttons_location': 'top', |
86 | | - "prev_next_buttons_location": "both", |
87 | | - # 'style_external_links': False, |
88 | | - # 'style_external_links': True, |
89 | | - # 'style_nav_header_background': 'white', |
90 | | - # Toc options |
91 | | - # 'collapse_navigation': True, |
92 | | - "collapse_navigation": False, |
93 | | - # 'sticky_navigation': True, |
94 | | - "sticky_navigation": False, |
95 | | - # 'navigation_depth': 4, |
96 | | - "navigation_depth": -1, |
97 | | - "includehidden": True, |
98 | | - "titles_only": False, |
99 | | -} |
100 | | - |
101 | 73 | # Add any paths that contain custom static files (such as style sheets) here, |
102 | 74 | # relative to this directory. They are copied after the builtin static files, |
103 | 75 | # so a file named "default.css" will overwrite the builtin "default.css". |
104 | 76 | html_static_path = ["_static"] |
105 | | -# html_static_path = ['../_static'] |
| 77 | + |
| 78 | +master_doc = "index" |
106 | 79 |
|
107 | 80 | html_context = { |
108 | 81 | "display_github": True, |
109 | 82 | "github_user": "nexB", |
110 | | - "github_repo": "spats", |
| 83 | + "github_repo": "aboutcode-toolkit", |
111 | 84 | "github_version": "develop", # branch |
112 | 85 | "conf_py_path": "/docs/source/", # path in the checkout to the docs root |
113 | 86 | } |
|
116 | 89 | "theme_overrides.css", |
117 | 90 | ] |
118 | 91 |
|
119 | | -html_js_files = [ |
120 | | - "js/custom.js", |
121 | | -] |
122 | 92 |
|
123 | 93 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
124 | 94 | html_show_sphinx = True |
|
127 | 97 | # .. role:: is used to refer to styles defined in _static/theme_overrides.css |
128 | 98 | # and is used like this: :red:`text` |
129 | 99 | rst_prolog = """ |
| 100 | +.. |psf| replace:: Python Software Foundation |
| 101 | +
|
130 | 102 | .. # define a hard line break for HTML |
131 | 103 | .. |br| raw:: html |
132 | 104 |
|
|
142 | 114 |
|
143 | 115 | # -- Options for LaTeX output ------------------------------------------------- |
144 | 116 |
|
145 | | -latex_elements = { |
146 | | - 'classoptions': ',openany,oneside' |
147 | | -} |
| 117 | +latex_elements = {"classoptions": ",openany,oneside"} |
0 commit comments