Commit Graph

53 Commits

Author SHA1 Message Date
Takeshi KOMIYA
6e420e517e
Merge pull request #4465 from tk0miya/improve_config
Improve config
2018-01-21 16:05:34 +09:00
Stephen Finucane
b7749c6ca3 doc: Move sphinx.config API docs to code
Once again, we make things a little smarter by using Python domain
roles.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 12:53:45 +00:00
Stephen Finucane
391cd8195b doc: Move sphinx.errors API docs to code
This allows us to do something like 'help(sphinx.errors)' in code. We
reword the exception descriptions per Python stdlib conventions.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-01-20 12:47:49 +00:00
Takeshi KOMIYA
29df3a095a Add config-inited event 2018-01-20 21:21:45 +09:00
Takeshi KOMIYA
ae620e16f7 doc: Fix typo 2018-01-20 21:09:51 +09:00
Takeshi KOMIYA
1869f4d674 Update docs (refs: #3923) 2017-07-16 01:48:09 +09:00
Takeshi KOMIYA
6d2bcf9c27 Mark as experimental 2017-05-07 16:13:19 +09:00
Takeshi KOMIYA
d1e8e41b5e Fix #3633: misdetect unreferenced citations 2017-04-29 23:22:00 +09:00
Takeshi KOMIYA
621a4e6f61 Fix #3628: Rename sphinx_themes entry point to sphinx.html_themes 2017-04-22 14:59:10 +09:00
Takeshi KOMIYA
f21ce2f03f Fix markup 2017-04-20 02:02:27 +09: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
1cfed262d2 Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2017-04-15 15:54:06 +02:00
Takeshi KOMIYA
99ded4c8b1 Add Sphinx.add_post_transform() 2017-03-10 10:49:08 +09:00
Jellby
3ce6168958 Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2017-03-04 12:03:15 +01:00
Jakub Wilk
a58ebedffd Fix typos 2017-02-07 20:14:47 +01:00
Takeshi KOMIYA
da15090c83 Update docs for collectors API 2017-01-28 20:44:40 +09:00
Takeshi KOMIYA
269139ec0c Update docs 2017-01-07 15:10:53 +09:00
Takeshi KOMIYA
431d865d4a Drop deprecated options for html builder 2017-01-05 13:51:55 +09:00
Jellby
9bef597a2f Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2016-09-29 20:21:50 +02:00
miyakogi
0c89808112 Sphinx.add_source_parser takes only two arguments
https://github.com/sphinx-doc/sphinx/blob/master/sphinx/application.py#L794
2016-05-27 23:32:29 +09:00
Ignacio Fdez. Galván
6e93ba6db8 Merge remote-tracking branch 'upstream/master' 2016-02-29 18:25:26 +01:00
Takeshi KOMIYA
2ec60d5919 Fix #1858: Support numbering custom nodes 2016-02-14 14:49:34 +09:00
Takeshi KOMIYA
a391b1a1db Add Sphinx.add_enumerable_node() to add enumerable nodes for numfig feature 2016-02-14 14:49:34 +09:00
Jellby
4aaccc7fd9 Merge remote-tracking branch 'upstream/master'
Conflicts:
	tests/test_build_html.py
2016-02-08 20:34:15 +01:00
Takeshi KOMIYA
f81ab1e8b9 Fix #2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension 2016-01-04 10:23:17 +09:00
Jakub Wilk
f86217c9d1 Fix typos. 2016-01-01 20:54:30 +01: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
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
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
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +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
e7ed7cd627 Rename env-read-docs to env-before-read-docs, add changelog entry and fixup tests. 2014-09-22 09:13:44 +02:00
Georg Brandl
3c5cda97d1 Merged in guillemNaN/sphinx (pull request #261)
Add env-read-docs event to allow modify docnames list before processing
2014-09-22 09:05:00 +02:00
Takayuki Shimizukawa
f7399a261a Add app.set_translator() API to register or override a Docutils translator class like :confval:html_translator_class. 2014-08-05 00:18:54 +09:00
Takayuki Shimizukawa
2e1c16486c * fix code to pass test, add versionadded to doc, update CHANGES for pull request #229 2014-08-03 19:19:31 +09:00
Takayuki Shimizukawa
9191ffaa50 Merged in russell/sphinx-pluggable-translators (pull request #229)
Allow registration of other translators
2014-08-03 18:52:02 +09:00
Guillem Barba
b4b15181b4 Add env-read-docs event to allow modify docnames list before processing 2014-07-31 18:28:47 +02:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Georg Brandl
04065625ed merge with stable 2014-03-26 07:30:55 +01:00
Georg Brandl
c24cfbaed1 Add an example how to connect events. 2014-03-26 07:30:48 +01:00
Russell Sim
45a0bcd453 Allow registration of other translators
This adds an add_translator method to the sphinx application class.
It allows developers to register custom translators (writers) with
sphinx, so other extensions that add new nodes can register support
for the custom translators.
2014-03-20 12:34:11 +11:00
Georg Brandl
85ddf03f45 merge with stable 2014-03-02 08:50:10 +01:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
6b33e3fea4 remove duplicate wording 2014-01-21 10:05:23 +01:00
Georg Brandl
cc8d29dcab actually use exception markup 2014-01-21 10:04:11 +01:00