Commit Graph

1127 Commits

Author SHA1 Message Date
Robert Lehmann
3eb4afaa1a Document pass-through of language in HTML templates.
Originally added in dee3e60.
2015-02-14 10:02:04 +01:00
Jakob Lykke Andersen
44ee988981 C++, update docs and enums. Fixes sphinx-doc/sphinx#772. 2015-02-08 23:09:44 +01:00
Jakob Lykke Andersen
d8a109976b Merge from master 2015-02-07 00:55:19 +01:00
Georg Brandl
accb32ff07 The `env-updated` event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten.
(reference: #1683)
2015-01-25 16:13:04 +01:00
EricFromCanada
0f0ffbb982 revised pygments_style description 2015-01-06 10:51:54 -05:00
EricFromCanada
3111f7b6b3 rewording of highlight_options description 2015-01-05 23:22:19 -05:00
EricFromCanada
a63e4945ea Add highlight_options configuration value
This changeset adds the `highlight_options` configuration value, which
specifies a dict of key-value pairs to pass to the Pygments highlighter
specified with `highlight_language`. For example, specifying
`highlight_options = {'funcnamehighlighting' : False}` for the 'php'
lexer will disable function name highlighting.
Both the HTML and LaTeX writers have been updated to include the
options when calling `highlight_block()`, as long as the currently
selected language matches what was set with `highlight_language`, i.e.
not when modified by `highlight::` or `code-block::` directives.
2015-01-05 12:58:43 -05:00
Georg Brandl
a23903d8d5 Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199 all: update copyright 2015-01-03 21:36:32 +01:00
Jakob Lykke Andersen
c010b47589 C++, initial enum support (see #772) 2015-01-03 16:59:08 +01:00
Georg Brandl
91887b0183 Merge branch 'stable' 2015-01-02 13:51:31 +01:00
Georg Brandl
a84e036622 development process updates: bb->gh, hg->git 2015-01-02 13:49:38 +01:00
Takayuki Shimizukawa
aa79c97da7 merge with stable 2014-12-05 19:44:05 +09:00
Takayuki Shimizukawa
c00dd30fb7 replace PIL with Pillow. 2014-12-03 23:13:21 +09:00
Takayuki Shimizukawa
292abeeedb update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or later. 2014-12-03 23:17:48 +09:00
Takayuki Shimizukawa
6993a7254c fix documentation for extension development tutorial. Closes #1624. Thanks to dkeeney_fastacash. 2014-11-26 20:14:31 +09:00
Georg Brandl
6c194ad56f Closes #1623: Return types specified with `:rtype:` are now turned into links if possible. 2014-11-12 11:32:21 +01:00
Takayuki Shimizukawa
9bd306840f change a link for documentation translation page: from 1.2 to 1.3 2014-11-04 10:27:53 +09:00
Takayuki Shimizukawa
2710f705a1 fix: support python versions. 2014-10-30 10:13:54 +09:00
Takayuki Shimizukawa
dc482fd247 use reference to python 3.4 for intersphinx 2014-10-30 10:08:33 +09:00
Takayuki Shimizukawa
5bd2143fd0 enable sphinx.ext.viewcode for sphinx doc itself 2014-10-28 13:45:27 +09:00
Georg Brandl
96ce3b1374 Closes #1597: Added possibility to return a new template name from html-page-context. 2014-10-23 07:58:23 +02:00
Takayuki Shimizukawa
8b2f784dad Merged in westurner/sphinx-1/westurner/doc-invocationrst-sphinxapidoc-m-option-1413253549167 (pull request #308)
DOC: invocation.rst: sphinx-apidoc -M option
2014-10-22 00:24:48 +09:00
Wes Turner
5fb0c374e9 DOC: Add reference to markup/para.rst#glossary-directive from markup/inline.rst 2014-10-18 01:59:13 -05:00
Wes Turner
6bbd4c00d5 DOC: invocation.rst: sphinx-apidoc -M option 2014-10-14 02:25:56 +00:00
Takayuki Shimizukawa
d289870f48 rename numfig_prefix to numfig_format. later is better for the purpose. 2014-10-10 00:19:17 +09:00
Takayuki Shimizukawa
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +09:00
Takayuki Shimizukawa
2826af738d Merged in tk0miya/sphinx (pull request #303)
Add :numref: role to refer figures, tables and code-blocks by its fignum
2014-10-09 19:45:50 +09:00
tk0miya
83e8bbf58b Add docs about :numref: role 2014-10-09 19:31:36 +09:00
tk0miya
e32883433a Update docs by reviewing 2014-10-09 01:41:51 +09:00
Takayuki Shimizukawa
b9a39f0ea0 Merged in shimizukawa/sphinx (pull request #305)
gettext speed-up. closes #1426
2014-10-09 00:59:39 +09:00
Takayuki Shimizukawa
27f89b9e99 fix documentation for websupport. 2014-10-09 00:57:01 +09:00
Takayuki Shimizukawa
90e9957240 fix grammar by review 2014-10-08 21:36:33 +09:00
tk0miya
18051a5110 Add docs about confval for numfig 2014-10-08 11:03:14 +09:00
Jeppe Pihl
a3745cfb5e merge 2014-10-06 10:35:33 +02:00
Takayuki Shimizukawa
fa30e7b52a If the `python-levenshtein` 3rd-party package is installed, it will improve the calculation time. refs #1426. 2014-10-05 22:25:50 +09:00
Takayuki Shimizukawa
ee98decec1 Incompatibility. Now :confval:gettext_uuid is set False by default. If False, also levenshtein calculation is disabled. refs #1426 2014-10-05 21:50:44 +09:00
Jeppe Pihl
5c48682cc9 added documentation for lineno-match option 2014-10-04 15:36:38 +02:00
Takayuki Shimizukawa
ecfeece952 pull request #299 has been merged. Add documentation for sphinx-quickstart options, update a few statement and CHANGES. Closes #1501. 2014-10-04 14:14:31 +09:00
tk0miya
7e59c5385e Merge with default 2014-09-28 21:56:20 +09:00
Takayuki Shimizukawa
9d1225a35b add :confval:gettext_enables to enable extracting 'index' to gettext catalog output / applying translation catalog to generated documentation. Closes #1344 2014-09-28 21:19:54 +09:00
tk0miya
16529c5604 Add options argument to Sphinx.add_latex_package() 2014-09-28 21:10:26 +09:00
tk0miya
c04ad2908e Add new API: Sphinx.add_latex_package()
Sphinx.add_latex_package() allows sphinx extensions to add latex packages.
It helps creating extensions for latex (for example, latex-theming)
2014-09-27 12:47:27 +09:00
Georg Brandl
e3135cfc87 Make remaining builtin extensions parallel-read-proof. 2014-09-22 22:05:03 +02:00
Georg Brandl
52e5316b6e Document env-merge-info event, add parallel reading to changelog 2014-09-22 21:55:11 +02:00
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
71cd2f7e50 Change extension setup() return value to a dictionary of metadata.
This makes it possible to introduce more metadata values later.
2014-09-22 11:06:42 +02:00
Georg Brandl
7aa43488ea add a paragraph about sphinx-contrib on the front page 2014-09-22 10:20:02 +02:00
Georg Brandl
772dbbd4d9 Fix the docs index sidebar for unreleased versions. 2014-09-22 09:58:09 +02:00
Georg Brandl
e7ed7cd627 Rename env-read-docs to env-before-read-docs, add changelog entry and fixup tests. 2014-09-22 09:13:44 +02:00