Commit Graph

80 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
ff7545a191 Allow NoUri from 'missing-reference' handlers.
Also extend documentation of 'missing-reference'.
2020-05-17 12:34:33 +02:00
Takeshi KOMIYA
f13c546862 doc: Update docs 2020-03-07 02:00:50 +09:00
Takeshi KOMIYA
7c8b32a85d doc: Remove a mention to todo ext. from env-merge-info 2020-03-06 22:42:06 +09:00
Takeshi KOMIYA
e7a0af807a Merge branch '2.0' 2020-01-30 23:29:32 +09:00
Takeshi KOMIYA
2e22e96061 Add new event: :event:object-description-transform 2020-01-25 17:12:41 +09:00
Takeshi KOMIYA
b968bb91e9 Close #6830: autodoc: consider a member private if docstring has "private" metadata 2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
b9d7239d90 Merge branch '2.0' 2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
06f86b0639 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-16 14:06:36 +09:00
Takeshi KOMIYA
9e2aba54d3 Make EventManager portable
So far, we need to bypass application object for modules to emit
a event.  This make EventManager portable and easy to pass event
emitter.  This brings modules less coupled with application object.
2019-04-06 15:36:50 +09:00
Takeshi KOMIYA
61098a0ae2 Drop features and APIs deprecated in 1.8 2019-03-30 14:50:37 +09:00
Takeshi KOMIYA
eaec3bd916 Add sphinx.project; a manipulator for project and documents 2018-10-16 10:34:58 +09:00
Takeshi KOMIYA
a7cab001d9 Drop APIs deprecated in 2.0 2018-09-03 00:31:33 +09:00
Takeshi KOMIYA
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
158d7d2fd3 docs: Fix location of attributes 2018-06-05 22:57:04 +09:00
Takeshi KOMIYA
72011465ad
Merge pull request #5020 from tk0miya/5018_update_docs
Fix #5018: wrong signature of env-merge-info and env-check-consistency
2018-05-29 01:25:46 +09:00
Takeshi KOMIYA
1deceda6da
Merge branch 'master' into 3606_load_mathjax_async 2018-05-28 23:04:13 +09:00
Takeshi KOMIYA
814abfd020 Fix #5018: wrong signature of env-merge-info and env-check-consistency 2018-05-28 21:38:16 +09:00
Takeshi KOMIYA
f3168d9894 Rename app.add_javascript() to add_js_file() 2018-05-24 23:59:49 +09:00
Takeshi KOMIYA
8fd34b88d3 add_javascript() allows keyword arguments as attributes for <script> tag 2018-05-24 23:59:49 +09:00
Takeshi KOMIYA
297ea8070f Update docs 2018-05-24 23:55:12 +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
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
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