Takeshi KOMIYA
641174db5d
Merge pull request #9447 from Blendify/Blendify/html-templates-sphinx-version
...
HTML Templates: Expose full sphinx version tuple
2021-08-02 02:08:50 +09:00
Aaron Carlisle
426fdcabcd
HTML Templates: Expose full sphinx version tuple
...
Previously, there was only a string which is problematic
when you want to programmatically compare versions
for compatibility reasons.
2021-07-13 20:44:46 -04:00
Juan Luis Cano Rodríguez
c9d2a73d93
Rename to root document
2021-06-22 15:27:54 +02:00
igo95862
cfa449624d
doc: Moved Jinja links to new home page and HTTPS
...
Seems like Jinja is no longer pocoo project but
palletsprojects.com
2021-05-17 20:38:48 +03:00
Takeshi KOMIYA
3059a999b2
Close #8326 : Rename master_doc to root_doc
...
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`. The old name is still available. But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +09:00
Takeshi KOMIYA
65a69965a1
html theme: Add favicon_url and logo_url
...
To embed the external favicon and logo image, this adds new template
variable `favicon_url` and `logo_url` that point the external URL or
relative path for the favicon/logo file from current file. It helps to
use it on template files.
2021-01-23 20:39:09 +09:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Stephen Finucane
e4e5c509b6
doc: Rework "templating" documents
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2020-05-30 15:29:13 +01:00
Takeshi KOMIYA
f13c546862
doc: Update docs
2020-03-07 02:00:50 +09:00
Vince Salvino
9fdc18d8de
Adding documentation
2020-02-21 18:41:46 -05:00
Takeshi KOMIYA
d6063ff35b
doc: Fold lines by 80 columns
2019-05-30 01:07:05 +09:00
Takeshi KOMIYA
fa00458f4f
docs: Fold lines by 80 chars
2019-05-12 17:57:38 +09:00
Takeshi KOMIYA
68e0210746
doc: Add deprecation info to script_files (template variable)
2018-11-21 20:15:47 +09:00
Takeshi KOMIYA
52ed9ef3a0
Closes #2157 : helper function `warning()` for HTML themes is added
2018-03-19 00:18:10 +09:00
Aaron Carlisle
8ef71551cb
Docs: Templating: Small wording fix
2018-02-16 18:58:47 -05:00
Kurt McKee
beefd445c1
Convert doc HTTP links to HTTPS, even in documentation examples
...
A small number of URL's redirected, or were stale but had obvious
alternatives. These have been updated. For example, a Google style
guide for Python was no longer available at googlecode.com, and
Paver docs are now at readthedocs.io.
2018-01-20 16:50:35 -06:00
Jellby
e59a8028d7
Rewrite and simplify stylesheet handling
...
Thanks to tk0miya's comment, I learnt one can add stuff to template
blocks, that allows a much simpler stylesheet configuration, considering
that changes at the template level will be more... well, low-level.
Hopefully this is now acceptable.
2017-04-15 17:07:33 +02:00
Jellby
68cf06a2ce
Update version (there's still hope)
2017-03-04 12:14:54 +01:00
Jellby
3ce6168958
Merge remote-tracking branch 'upstream/master'
...
Conflicts:
tests/test_build_html.py
2017-03-04 12:03:15 +01:00
Timotheus Kampik
0b4ebbeebb
Improve templating options documentation #2788
...
--
Move `parents`, `prev` & `next` to
*documents that are created from source files* section.
It doesnt make any sens to use them for auto-generated files like index and
search, does it?
Add documentation for `body`, `display_toc`, `metatags` and `title`.
2017-01-22 22:05:35 +01:00
Jellby
6ce1bb1f00
Merge remote-tracking branch 'upstream/master'
...
Conflicts:
sphinx/application.py
sphinx/builders/html.py
2016-12-06 19:14:12 +01:00
Takeshi KOMIYA
463ab88b67
docs: sourcename has empty value on creating genindex and so on (refs: #3094 )
2016-11-04 23:36:27 +09:00
Jellby
ea219a04ed
Move CSS properties to a different variable
2016-03-06 13:49:57 +01:00
Ignacio Fdez. Galván
d5cbda5c79
Merge remote-tracking branch 'upstream/master'
2015-07-09 17:35:23 +02:00
Eric Holscher
5f6503c905
Add suffix to HTML context. Fixes #1873
2015-06-06 13:12:56 -07:00
Ignacio Fdez. Galván
204b9cc521
Changed 'rel' to 'alternate'
2015-03-12 10:51:45 +01:00
Ignacio Fdez. Galván
a18c04b955
Allow setting 'rel' and 'title' attributes for stylesheets.
2015-03-11 15:48:40 +01:00
Robert Lehmann
3eb4afaa1a
Document pass-through of language in HTML templates.
...
Originally added in dee3e60
2015-02-14 10:02:04 +01:00
EricFromCanada
4883e1eba2
more corrections for spelling and grammar
2014-06-19 12:14:47 -04:00
EricFromCanada
178a97cd73
improved consistency for how docs refer to True and False
2014-06-18 12:34:28 -04:00
Georg Brandl
48524dcecc
Closes #983 : clarify "docstitle" behavior with singlehtml
2014-01-11 20:18:37 +01:00
Roland Meister
50fadb9e94
Bug #1047 : templating toctree()'s includehidden argument
...
Document the includehidden option and give it sane defaults.
See bug #1047 for implementation alternatives.
2012-12-10 21:54:11 +01:00
Georg Brandl
8965cf1095
Closes #658 : fix error in script_files example and document css_files.
2011-05-15 13:05:31 +02:00
Georg Brandl
580e1c90d3
#481 , #482 : fix `.name` reference matching.
...
#482 : When doing a non-exact search, match only the given type of object.
#481 : Apply non-exact search for Python reference targets with ``.name`` for modules too.
2010-08-05 13:39:23 +02:00
Georg Brandl
187e78adf6
Mention type of "meta".
2010-06-14 09:49:48 +02:00
Georg Brandl
35f0b555a4
The `toctree callable in templates now accepts a titles_only` keyword argument.
2010-05-30 13:16:26 +02:00
Georg Brandl
454ecf80a4
Make the concept of "module index" generalized to domains. As a side-effect, the latex modindex is no longer generated by LaTeX.
2010-02-20 01:13:23 +01:00
Georg Brandl
c227fc2720
merge with trunk (and remove debugging leftover from test layout.html template)
2010-01-07 21:51:23 +01:00
Georg Brandl
03b9d79b34
Fix compatibility with blocks in the old sidebar scheme: blocks cannot be used in included templates. Deprecate the blocks accordingly.
2010-01-07 21:49:31 +01:00
Georg Brandl
5d0812fb91
merge with trunk
2009-12-28 19:49:57 +01:00
Georg Brandl
98437cfd28
Fix typo.
2009-12-01 21:04:46 +01:00
Georg Brandl
0792ad7498
The `toctree() callable in templates now has a maxdepth`
...
keyword argument to control the depth of the generated tree.
Also add tests for that callable.
2009-09-09 15:56:52 +02:00
Georg Brandl
a43b651804
Make "make check" happy.
2009-02-19 23:31:34 +01:00
Georg Brandl
d5ea00899c
Change html_collapse_toctree setting to an argument of the toctree() callable.
2009-02-16 00:08:08 +01:00
Georg Brandl
106ef21629
More templating docs.
2009-02-15 11:38:23 +01:00
Georg Brandl
e974741c74
Added a toctree variable to the templates, and the ability to
...
include external links in toctrees.
Patch by Stefan Seefeld.
2009-01-26 21:57:15 +01:00
Georg Brandl
f02a90ca6e
Add sidebarsourcelink block.
2008-12-20 23:08:26 +01:00
Georg Brandl
bd12a8e547
Some more fixes after the great renaming.
2008-11-29 20:04:11 +01:00
Georg Brandl
3d3bcb00df
Rename rellinks to linktags.
2008-09-24 11:48:43 +00:00
Georg Brandl
262edb1413
Add logo options, add blocks to sidebar.
2008-04-27 19:43:45 +00:00
