IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-08-05 18:56:53 -05:00
Code Issues Packages Projects Releases Wiki Activity
9,869 Commits 11 Branches 236 Tags
9f5c676322200f0402a32873ba6cac6c6a0ff680
Commit Graph
88 Commits
Author SHA1 Message Date
Stephen Finucane a83e8bab7d builders: Add 'Builder.epilog' option 
This allows builders to emit a final epilog message containing
information such as where resulting files can be found. This is only
emitted if the build was successful.

This allows us to remove this content from the 'make_mode' tool and
the legacy 'Makefile' and 'make.bat' templates. There's room for more
dramatic simplification of the former, but this will come later.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Takeshi KOMIYA 242bf9a38a Fix typo 2017-12-20 00:11:28 +09:00
Takeshi KOMIYA 04995b703f Fix typo 2017-12-20 00:05:57 +09:00
Takeshi KOMIYA 8bb6a01210 Fix mark up 2017-12-17 02:21:10 +09:00
Takeshi KOMIYA 299b11f26f Replace AutodocReporter by switch_source_input() 2017-12-17 02:13:11 +09:00
Takeshi KOMIYA abaf1cbb6b Merge branch 'stable' 2017-07-29 16:01:47 +09:00
Timotheus Kampik e8cfd0f3d4 #1685 remove non-existing attributes from custom directive doc 2017-07-15 21:49:35 +02: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
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