|
62 | 62 | # to convert quotes and dashes to typographically correct entities. |
63 | 63 | # Note to maintainers: setting this to `True` will cause contractions and |
64 | 64 | # hyphenated words to be marked as misspelled by spellchecker. |
65 | | -smartquotes=False |
| 65 | +smartquotes = False |
66 | 66 |
|
67 | 67 | # The name of the Pygments (syntax highlighting) style to use. |
68 | 68 | # pygments_style = "sphinx.pygments_styles.PyramidStyle" |
|
136 | 136 | # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html |
137 | 137 | myst_enable_extensions = [ |
138 | 138 | "deflist", # You will be able to utilise definition lists |
139 | | - # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists |
| 139 | + # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists |
140 | 140 | "linkify", # Identify “bare” web URLs and add hyperlinks. |
141 | 141 | "colon_fence", # You can also use ::: delimiters to denote code fences,\ |
142 | | - # instead of ```. |
| 142 | + # instead of ```. |
143 | 143 | "substitution", # plone.restapi \ |
144 | | - # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2 |
| 144 | + # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2 |
145 | 145 | ] |
146 | 146 |
|
147 | 147 | myst_substitutions = { |
|
208 | 208 | html_logo = "_static/logo.svg" |
209 | 209 | html_favicon = "_static/favicon.ico" |
210 | 210 |
|
211 | | -html_css_files = ["custom.css", |
212 | | - ("print.css", {"media": "print"})] |
| 211 | +html_css_files = ["custom.css", ("print.css", {"media": "print"})] |
213 | 212 |
|
214 | 213 | # See http://sphinx-doc.org/ext/todo.html#confval-todo_include_todos |
215 | 214 | todo_include_todos = True |
|
258 | 257 | # Grouping the document tree into LaTeX files. List of tuples |
259 | 258 | # (source start file, target name, title, author, documentclass [howto/manual]) |
260 | 259 | latex_documents = [ |
261 | | - ("index", "PloneDocumentation.tex", "Plone Documentation", |
262 | | - "The Plone community", "manual"), |
| 260 | + ( |
| 261 | + "index", |
| 262 | + "PloneDocumentation.tex", |
| 263 | + "Plone Documentation", |
| 264 | + "The Plone community", |
| 265 | + "manual", |
| 266 | + ), |
263 | 267 | ] |
264 | 268 |
|
265 | 269 | # The name of an image file (relative to this directory) to place at the top of |
266 | 270 | # the title page. |
267 | 271 | latex_logo = "_static/logo_2x.png" |
| 272 | + |
| 273 | + |
| 274 | +# suggest edit link |
| 275 | +# remark: {{ file_name }} is mandatory in "edit_page_url_template" |
| 276 | +html_context = { |
| 277 | + "edit_page_url_template": "https://6.dev-docs.plone.org/contributing/index.html?{{ file_name }}#making-contributions-on-github", |
| 278 | +} |
0 commit comments