Commit Graph

130 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a68f772d7a Merge branch 'master' into refactor_config 2018-04-28 13:05:47 +09:00
Takeshi KOMIYA
b165ade6b0 Rename Config.read_from_py() to Config.read() 2018-04-28 13:05:28 +09:00
Takeshi KOMIYA
d505d232de
Merge pull request #4884 from tk0miya/4873_adjust_word-break
Fix #4873: Adjust word-break of deprecated-APIs table
2018-04-22 21:31:56 +09:00
Takeshi KOMIYA
d97dc05b37 Fix #4873: Adjust word-break of deprecated-APIs table 2018-04-22 20:00:46 +09:00
Takeshi KOMIYA
5897d45cc6 Merge branch 'master' into refactor_config 2018-04-22 18:56:04 +09:00
Takeshi KOMIYA
1542622cf7
Merge pull request #4853 from tk0miya/4810_order_of_transforms
Change processing order of reading a document
2018-04-21 19:17:27 +09:00
Takeshi KOMIYA
ed3bc1a87e
Merge pull request #4833 from tk0miya/add_docs_for_ImageConverter
doc: Add ImageConverter to utils
2018-04-21 14:44:02 +09:00
Takeshi KOMIYA
6b14cd3bd6 Change priority of versioning doctrees 2018-04-21 11:28:23 +09:00
Takeshi KOMIYA
ea7d30a190 doc: Add ImageConverter to utils 2018-04-21 11:21:27 +09:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-18 19:51:48 -07:00
Takeshi KOMIYA
c35eb6fade
Merge pull request #4815 from tk0miya/refine_add_css_file
Refine adding CSS files
2018-04-13 00:21:33 +09:00
Takeshi KOMIYA
1dd605971c
Merge pull request #4804 from tk0miya/add_SphinxDirective
Add SphinxDirective class
2018-04-08 23:30:19 +09:00
Takeshi KOMIYA
3afc72fba4 Rename add_stylesheet() to add_css_file() 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
47918f365e Merge branch 'master' into refactor_config 2018-04-02 10:47:47 +09:00
Takeshi KOMIYA
bc63dc8450 Rename Config.read() to Config.from_conf_py() 2018-04-01 20:07:45 +09:00
Takeshi KOMIYA
ab04a55dbf Add document for utility classes 2018-03-31 00:05:03 +09:00
Takeshi KOMIYA
962b6d459e Drop document.settings.gettext_compact 2018-03-30 13:06:11 +09:00
Takeshi KOMIYA
72a0896bd0 Merge branch 'master' into add_override_option 2018-03-29 22:03:05 +09:00
Takeshi KOMIYA
61828786a6 Deprecate app.override_domain() 2018-03-29 21:59:29 +09:00
Takeshi KOMIYA
a24601aa24 Deprecate Config.check_unicode() 2018-03-29 10:32:49 +09:00
Takeshi KOMIYA
febca7cf26 Merge branch 'master' into refactor_config 2018-03-28 01:01:03 +09:00
Takeshi KOMIYA
0f3fa689a4 Deprecate env._nitpick_ignore 2018-03-26 02:05:58 +09:00
Takeshi KOMIYA
78cbf96158 Deprecate Config.check_types() 2018-03-24 00:29:11 +09:00
Takeshi KOMIYA
ba83214386 Refactor: Add Config.read() as a constructor
To simplify Config.__init__() method, this separates conf.py parsing
feature to Config.read() method.
This allows to instantiate config object simply.
2018-03-23 23:40:28 +09:00
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