Commit Graph

269 Commits

Author SHA1 Message Date
Takeshi KOMIYA
08bc847964 Deprecate abbreviation node (refs: #5720) 2018-12-15 20:13:04 +09:00
Takeshi KOMIYA
d898da697d Refactor Autosummary directive by DocumenterBridge 2018-12-10 22:36:44 +09:00
Jon Dufresne
3a96ce6591 Deprecate unused and untested sphinx.util functions
sphinx.util.attrdict: Last use removed in
b09e628b0f.

sphinx.util.PeekableIterator: Last use removed in
85b8a451a6.
2018-12-09 14:54:50 -08:00
Takeshi KOMIYA
c8ce761a73 deprecate SphinxRSTFileInput 2018-12-05 23:11:16 +09:00
Takeshi KOMIYA
1a50d34520 refactor `mock()` to based on PEP-451 implementation 2018-12-04 23:57:01 +09:00
Takeshi KOMIYA
b837a5aec0 refactor TexinfoTranslator; Replace _make_visit_admonition() 2018-12-04 01:40:15 +09:00
Takeshi KOMIYA
f5b7d24003 refactor LaTeXTranslator; Replace _make_visit_admonition() 2018-12-04 01:40:14 +09:00
Takeshi KOMIYA
97615beda2 refactor TextTranslator; Replace _make_depart_admonition() 2018-12-04 01:40:14 +09:00
Arthur
adc1d2b59d
Merge branch 'master' into docs/extension-tutorials 2018-11-30 10:33:20 +01:00
Takeshi KOMIYA
f7317651a1 Refactor sphinx.search 2018-11-30 18:03:20 +09:00
ArtFlag
8479876798 Add a helloworld tutorial 2018-11-29 00:14:31 +01:00
ArtFlag
83e9e1378c Create a tutorial portal 2018-11-28 17:27:12 +01:00
Jon Dufresne
555960d668 Deprecate and drop internal use of force_decode()
In the Python 3 only code base, this function is no longer necessary.
The type of values is well understood and deliberate. Code should avoid
arbitrary mixing of bytes & str.

By removing force_decode() calls from docstring values, can deprecate
the now unused 'encoding' arguments to various autodoc methods.
2018-11-13 07:16:39 -08:00
Jon Dufresne
6fbf4a2f99 Deprecate sphinx.util.pycompat.u
It is now simply a constant equal to the empty string. Provides no
further utility.
2018-11-12 16:31:27 -08:00
Jon Dufresne
27a6787d63 Remove use of six.binary_type
Remove type checks for cases that don't apply to Python 3.

For remaining uses, use bytes instead
2018-11-11 19:09:47 -08:00
Takeshi KOMIYA
dcc4ac55bb latex: Move \pageautorefname to sphinxmessages.sty 2018-11-01 22:47:15 +09:00
Takeshi KOMIYA
ca8bc8ca49 refactor: Deprecate app._setting_up_extension 2018-10-17 11:56:11 +09:00
Takeshi KOMIYA
4ed5c51cff logging: Add prefixed_warnings() helper 2018-10-17 11:21:22 +09:00
Takeshi KOMIYA
491d0406df Deprecate get_matching_docs() 2018-10-16 10:34:59 +09:00
Takeshi KOMIYA
eaec3bd916 Add sphinx.project; a manipulator for project and documents 2018-10-16 10:34:58 +09:00
Takeshi KOMIYA
e7e07fd697 Merge branch '1.8' 2018-10-16 09:57:54 +09:00
Jon Dufresne
05ac246eff Deprecate Python2 compat shim sphinx.util.osutil.walk()
Code should use os.walk() instead, which works with either str or bytes.
All internal calls use str.
2018-10-05 12:39:50 -07:00
Takeshi KOMIYA
0e4c23fc35 Deprecate string style base for env.doc2path() 2018-09-22 23:22:11 +09:00
Takeshi KOMIYA
8bd2f921f9 Deprecate suffix for env.doc2path() 2018-09-22 23:21:34 +09:00
Takeshi KOMIYA
3a2418a827 refactoring: Drop PY2 and PY3 flags 2018-09-22 21:27:59 +09:00
jfbu
6f08c09ecb Improve Table of Deprecated APIs for LaTeX output (docs) 2018-09-22 11:44:04 +02:00
Takeshi KOMIYA
98648325aa Merge branch '1.8' 2018-09-22 17:16:24 +09:00
Takeshi KOMIYA
ae12f357c7 Fix #5463: mathbase: math_role and MathDirective was disappeared in 1.8.0 2018-09-21 23:44:11 +09:00
Takeshi KOMIYA
efdc95ef8b Merge branch '1.8' 2018-09-13 00:53:09 +09:00
Takeshi KOMIYA
b2b833d39e Update CHANGES for PR #5403 2018-09-10 20:45:16 +09:00
Takeshi KOMIYA
02afc357ef Merge branch '1.8' 2018-09-09 19:26:48 +09:00
Takeshi KOMIYA
8e729b419e Fix #5399: Sphinx crashes if unknown po file exists 2018-09-08 22:21:59 +09:00
Takeshi KOMIYA
a7cab001d9 Drop APIs deprecated in 2.0 2018-09-03 00:31:33 +09:00
Takeshi KOMIYA
864ded3d8a
Merge pull request #5343 from tk0miya/5340_update_docs
docs: Fix wrong descriptions for logging APIs
2018-08-26 11:30:51 +09:00
Takeshi KOMIYA
0a485740a8 docs: Fix wrong descriptions for logging APIs 2018-08-25 10:59:04 +09:00
Takeshi KOMIYA
328ff6eeae Fix i18n: warnings for translation catalogs have wrong line numbers 2018-08-22 21:01:50 +09:00
Takeshi KOMIYA
3d9e2cf831 Add autodoc_default_options 2018-08-18 18:22:16 +09:00
Takeshi KOMIYA
03d083e784 Move VersionChanges directive to sphinx.domains.changeset 2018-08-02 01:51:51 +09:00
Takeshi KOMIYA
25bfa1692a refactor: Move repository of changesets to domain from env 2018-08-02 01:51:50 +09:00
Takeshi KOMIYA
5fd62810b9
Merge pull request #5229 from tk0miya/refactor_latex2
Check latex_elements at config-inited event
2018-07-30 23:16:02 +09:00
Takeshi KOMIYA
5520969b39
Merge pull request #5228 from tk0miya/move_make_mode_to_sphinx.cmd
Move make mode to sphinx.cmd
2018-07-30 23:11:26 +09:00
Takeshi KOMIYA
90246b82b5 Check latex_elements at config-inited event 2018-07-29 22:43:13 +09:00
Takeshi KOMIYA
c8a66b73cf Update CHANGES 2018-07-29 22:24:56 +09:00
Takeshi KOMIYA
7218fe9dca Deprecate whole of sphinx.ext.mathbase 2018-07-29 12:32:46 +09:00
Takeshi KOMIYA
104bd42f51
Merge branch 'master' into refactor_highlighter 2018-07-29 11:21:36 +09:00
Takeshi KOMIYA
dd65d00f29 Implement math_renderer framework 2018-07-28 18:20:11 +09:00
Takeshi KOMIYA
f3019ee197 Apply :confval:trim_doctest_flags to all builders (cf. text, manpages) 2018-07-21 13:54:51 +09:00
Takeshi KOMIYA
4f296c5e67 Refactor: Run highlightlang on resolving phase 2018-07-21 13:54:09 +09:00
Takeshi KOMIYA
0c277f3ff0 `sphinx.highlighting.PygmentsBridge.unhighlight()` is deprecated 2018-07-21 01:50:23 +09:00
Matthias Geier
e1772bafda
DOC: Fix typo: add_source_parsers() -> add_source_parser() 2018-07-17 10:00:05 +02:00
Takeshi KOMIYA
d3cc565749
Merge branch 'master' into 4976_location_for_logger.info 2018-07-16 17:18:24 +09:00
Takeshi KOMIYA
910be1e2a2 Close #4976: `SphinxLoggerAdapter.info() now supports location` parameter 2018-06-26 01:02:37 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02:00
Roy Wellington Ⅳ
d66e663f28 Fix minor typo of "them" 2018-06-13 11:25:21 -07:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable 2018-06-08 19:53:46 +02:00
jfbu
359854fa78 Postpone to 3.0 removal of ExtBabel.get_shorthandoff() 2018-06-07 18:29:24 +02:00
Takeshi KOMIYA
b914327317 Reorder deprecated APIs (app) 2018-06-08 00:51:00 +09:00
Takeshi KOMIYA
e081b1f154 Reorder deprecated APIs (env) 2018-06-08 00:51:00 +09:00
Takeshi KOMIYA
a2c4ed6614 Fix wrong module name in CHANGES 2018-06-08 00:51:00 +09:00
jfbu
b41b1dac5c Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff()
This partially reverts d17f3955a5
2018-06-06 19:16:14 +02: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
3c6be1b5b3
Merge pull request #5008 from tk0miya/refactor_latex2
Refactor latex writer
2018-05-28 22:59:40 +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
c8e38fbe3e Refactor: Add DocumentTargetTransform to simplify LaTeX writer 2018-05-24 00:23:50 +09:00
Takeshi KOMIYA
489d86d470 Refactor: Add captioned_literal_block node to simplify LaTeX writer 2018-05-23 22:50:46 +09:00
Takeshi KOMIYA
e6c51bd535 refactor: Move math_reference node to sphinx.builders.latex.nodes
The node is only used in latex builder.  So this makes it builder-
specific node.
2018-05-20 15:13:59 +09:00
Takeshi KOMIYA
5f31f9dbab Enable eq role by default 2018-05-17 00:42:44 +09:00
Takeshi KOMIYA
a4c7be6fcd Move MathDomain to sphinx.domains.math 2018-05-17 00:42:24 +09:00
Takeshi KOMIYA
e675ad2ec9 Enable math_block node rendering by default (without HTML builders) 2018-05-17 00:42:22 +09:00
Takeshi KOMIYA
4e04bff4f5 Enable math node rendering by default (without HTML builders)
Nowadays, math elements (inline and block level equations) are
integrated into reST spec by default.  But, in Sphinx, they are
not enabled by default.  For this reason, users have to enable
one of math extensions even if target builder supports math
elements directly.

This change starts to enable them by default.  As a first step,
this replaces math node and its structure by docutils based one.
2018-05-15 22:27:49 +09:00
Takeshi KOMIYA
71e5acc84a doc: Fill N/A to deprecation list 2018-05-14 01:30:57 +09:00
Takeshi KOMIYA
5493bc1612
Merge branch 'master' into refactor_env2 2018-05-12 22:42:29 +09:00
Takeshi KOMIYA
d6db20781a Deprecate methods for pickling/unpickling on BuildEnvironment 2018-05-11 02:28:01 +09:00
Takeshi KOMIYA
fad03ea050 Rename viewcode_import to viewcode_follow_imported_members (refs: #4035) 2018-05-07 21:22:13 +09:00
Takeshi KOMIYA
304c208d32 Add BibliographyTransform to restruct doctree for LaTeX 2018-05-03 20:54:42 +09:00
Takeshi KOMIYA
8febb09373
Merge branch 'master' into refactor_latex_footnotes 2018-05-03 11:40:44 +09:00
Takeshi KOMIYA
39fe7ee293 refactor: Move env.write_doctree() to Builder._write_doctree() 2018-05-01 23:06:05 +09:00
Takeshi KOMIYA
90949a3b4f refactor: Move env.read_doc() to Builder._read_doc() 2018-05-01 23:06:05 +09:00
Takeshi KOMIYA
8e6c04c630
Merge branch 'master' into deprecate_highlightlang_directive 2018-04-29 21:13:13 +09:00
Takeshi KOMIYA
a31e7beee7 Merge branch 'master' into refactor_latex_footnotes 2018-04-29 21:09:46 +09:00
Takeshi KOMIYA
4118e8b35b
Merge branch 'master' into refactor_config 2018-04-29 19:00:04 +09:00
Takeshi KOMIYA
6b397d1fb1 Show warnings for deprecated html_search_options 2018-04-28 14:34:49 +09:00
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
Takeshi KOMIYA
abf8999ce7 Deprecate footnotes helpers 2018-04-20 22:14:49 +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
b35198d847 Deprecate highlightlang directive
highlightlang directive is not documented, and marked as old in v0.2.
2018-04-15 00:33:02 +09: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