IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
11,160 Commits 2 Branches 219 Tags 163 MiB
104bd42f51
Commit Graph

175 Commits

Author SHA1 Message Date
Jellby
1cfed262d2 Merge remote-tracking branch 'upstream/master' 
Conflicts:
	tests/test_build_html.py
 2017-04-15 15:54:06 +02:00
Brecht Machiels
3dd256fe7d Do not include the builder class in the entry point 
- use the entry point to load the extension module in the usual way
- update the documentation to reflect this change
 2017-04-14 11:01:09 +02:00
Brecht Machiels
405ef96d2a Find third-party builders by entry point 
A builder is uniquely identified by its name, which can be used as an
entry point in the 'sphinx.builders' entry point group. This obviates
the need to register the builder as an extension.

The built-in builders are still loaded as before. New third-party builders
should provide an entry point in their setup.py:

    entry_points={
        'sphinx.builders': [
            'mybuilder = mypackage.mymodule:MyBuilder',
        ],
    }

Like before, builders should define a setup(app) function in the
'mypackage.module' module to define configuration variables etc. It is
no longer necessary to register the builder using Sphinx.add_builder().

Existing builders can still be loaded the traditional way, by including
their module name in the extensions list in conf.py.
 2017-04-10 13:04:41 +02:00
Takeshi KOMIYA
eb5577bb9c Update docs 2017-03-10 16:43:27 +09: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
Takeshi KOMIYA
e785200202 Merge pull request #3403 from jwilk/spelling 
Fix typos
 2017-02-08 10:27:19 +09:00
Jakub Wilk
a58ebedffd Fix typos 2017-02-07 20:14:47 +01:00
jfbu
6ae8f6ba18 logging module docs 2017-02-07 20:06:28 +01:00
Takeshi KOMIYA
da15090c83 Update docs for collectors API 2017-01-28 20:44:40 +09:00
Takeshi KOMIYA
1a821b89e9 Drop deprecated function: make_admonition() 2017-01-07 18:35:57 +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
Takeshi KOMIYA
76443623fa Drop deprecated termsep node 2017-01-05 13:44:04 +09:00
Takeshi KOMIYA
8140ae33b5 Add doc/extdev/logging.rst 2017-01-02 12:59:51 +09: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
Jakob Lykke Andersen
4c2815bc95 Make rendering of multiline signatures better in html. 2016-10-20 09:28:59 +02:00
Jellby
9bef597a2f Merge remote-tracking branch 'upstream/master' 
Conflicts:
	tests/test_build_html.py
 2016-09-29 20:21:50 +02:00
jfbu
1d7c82b3bb Merge branch 'stable' into master 
Conflicts (fixed)::
	sphinx/texinputs/sphinx.sty
 2016-09-07 23:18:09 +02:00
Takeshi KOMIYA
3eb56b1c6f doc: Use AutodocReporter at example of nested_parse_with_titles() 
In detail, please refer following thread:
https://groups.google.com/forum/#!topic/sphinx-dev/l4fHrIJfwq4
 2016-09-07 15:46:20 +09: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
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01: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
cf5e138a53 Merge pull request #2207 from tk0miya/baseclass_for_parsers 
Add sphinx.parsers.Parser class; a base class for new parsers
 2016-01-17 19:17:58 +09:00
Takeshi KOMIYA
f89e3dfee3 Update docs about sphinx.parsers.Parser class 2016-01-17 19:18:02 +09:00
Takeshi KOMIYA
738bb589d9 Merge pull request #2209 from tk0miya/2162_add_source_parser_API 
Fix #2162: Add Sphinx.add_source_parser() to add source_suffix and source_parsers from extension
 2016-01-17 19:07:18 +09:00
Takeshi KOMIYA
e4b9eb51f6 Merge branch 'stable' 2016-01-11 00:27:26 +09:00
Takeshi KOMIYA
bef3025c3c Fix #1900: BuildEnvironment.srcdir documentation gives false information 2016-01-07 14:18:40 +09: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
Takeshi KOMIYA
01a526793d Fix typos #2122 (cherry-picked by hand) 2016-01-02 11:17:59 +09:00
Jakub Wilk
f86217c9d1 Fix typos. 2016-01-01 20:54:30 +01:00
Ignacio Fdez. Galván
5d19ea38df Merge remote-tracking branch 'upstream/master' 2015-12-13 12:31:02 +01:00
shimizukawa
d51228152e merge with stable 2015-07-25 18:15:09 +02:00
shimizukawa
468568bdcf fix obsoleted documentation 2015-07-25 15:55:43 +02:00
Ignacio Fdez. Galván
d5cbda5c79 Merge remote-tracking branch 'upstream/master' 2015-07-09 17:35:23 +02:00
Jean Jordaan
56c51ff4b0 Some language edits while reading 2015-05-15 13:18:19 +08: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
Takayuki Shimizukawa
aa79c97da7 merge with stable 2014-12-05 19:44:05 +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
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
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
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
Georg Brandl
b6594d18d1 Add support for extensions to declare their version as a string returned from setup(). 2014-09-03 16:27:15 +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
Jean-Paul Calderone
19533c96a5 Fix a copy/paste (presumably) mistake in the extdev tutorial. 2014-04-04 11:53:37 -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
501c2d13e6 Fix long lines. 2014-03-02 08:40:48 +01:00
Georg Brandl
eb79fcafea merge with stable 2014-01-26 11:51:09 +01:00
Georg Brandl
25ac2dda9c add link 2014-01-24 20:22:58 +01:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
fb5a1a09a0 some directive creation docs 2014-01-21 10:32:30 +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
Georg Brandl
da09100869 doc: add exceptions from sphinx.errors 2014-01-21 09:54:31 +01:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00