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
10,416 Commits 2 Branches 219 Tags 163 MiB
42263a07a6
Commit Graph

106 Commits

Author SHA1 Message Date
Takeshi KOMIYA
52ed9ef3a0 Closes #2157: helper function `warning()` for HTML themes is added 2018-03-19 00:18:10 +09:00
Takeshi KOMIYA
b3cbfc2bb5 Update deprecation list 2018-03-15 01:57:39 +09:00
Takeshi KOMIYA
e2f481c956 Merge branch '1.7' 2018-03-03 20:03:45 +09:00
Takeshi KOMIYA
bd898be3fc doc: Add deprecation list 
So far, deprecated APIs are only listed as CHANGES entry.  But
they are not listed in one place.  In this change, I gathered them
to docs as a list.
As a side effect, it makes CHANGES entry simple.
 2018-03-02 00:01:49 +09:00
Takeshi KOMIYA
b3e7609a80 Update docs 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
5789b25847 Change interface of add_source_parser() and add add_source_suffix() 2018-02-21 10:54:49 +09:00
Takeshi KOMIYA
0010179d45 docs: Add description for attributes of Builder (refs: #4402) 2018-01-29 22:41:06 +09:00
Takeshi KOMIYA
32c5e8346f Close #4460: extensions should return the version of data structure as metadata 2018-01-25 02:04:22 +09:00
Stephen Finucane
487480ca01 doc: Add 'is_parallel_allowed' 
This is an important function and should be documented.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:37:59 +00:00
Stephen Finucane
6c23dac5a6 doc: Reorder 'sphinx.application' docs to match code 
Use the same ordering to minimize cognitive load.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:52 +00:00
Stephen Finucane
b7ff955472 doc: Move 'sphinx.application' API docs to code 
This allows us to do something like 'help(sphinx.application)' in code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:46 +00:00
Stephen Finucane
eaaab75ec2 doc: Rework 'sphinx.application' API documentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 10:49:38 +00:00
Takeshi KOMIYA
6e420e517e
Merge pull request #4465 from tk0miya/improve_config 
Improve config
 2018-01-21 16:05:34 +09:00
Stephen Finucane
b215f523f7 doc: Move sphinx.logging API docs to code 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-20 13:00:43 +00: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
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