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
19,362 Commits 2 Branches 219 Tags 163 MiB
4d7558e968
Commit Graph

519 Commits

Author SHA1 Message Date
Takeshi KOMIYA
3b49f9fe3d Separate htmlhelp to sphinxcontrib package 2019-02-15 01:44:32 +09:00
Takeshi KOMIYA
549a763195
Merge pull request #6025 from tk0miya/refactor_roles2 
Introduce SphinxRole class as a base class of roles
 2019-02-14 01:09:28 +09:00
Takeshi KOMIYA
2efc1065c0 Deprecate sphinx.util.pycompat:sys_encoding 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
b25deb259e refactor: Move NoneType to sphinx.util.typing 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
d40ce68c7b refactor: Move terminal_safe() to sphinx.util.console 2019-02-11 16:41:19 +09:00
Takeshi KOMIYA
ac70a4dd91 Replace :abbr: role by class based implementation 2019-02-06 01:20:58 +09:00
Takeshi KOMIYA
c4397318d3 Separate applehelp to sphinxcontrib package 2019-02-06 00:44:37 +09:00
Vincent Férotin
98fd02e262 doc: Enhance documentation about internalization of external extension. 2019-01-28 15:48:50 +01:00
Takeshi KOMIYA
2bd69350a7 Separate devhelp to sphinxcontrib package 2019-01-20 03:03:50 +09:00
Takeshi KOMIYA
6be9d2a08e Separate qthelp to sphinxcontrib package 2019-01-19 16:34:06 +09:00
Takeshi KOMIYA
20bf74c637 Separate jsmath to sphinxcontrib package 2019-01-13 14:07:12 +09:00
Takeshi KOMIYA
6429c9e23c
Merge branch 'master' into refactor_singlehtml 2019-01-12 21:17:16 +09:00
Takeshi KOMIYA
8b6acc05c4
Merge pull request #5909 from tk0miya/refactor_epub2 
refactor: Convert Epub3Builder.validate_config_values() to a function
 2019-01-12 18:22:00 +09:00
Takeshi KOMIYA
354e765eef refactor: Convert Epub3Builder.validate_config_values() to a function 2019-01-12 18:05:28 +09:00
Takeshi KOMIYA
b08a7c4757 Move SingleFileHTMLBuilder to sphinx.builders.singlehtml package 2019-01-11 01:59:56 +09:00
Takeshi KOMIYA
e82f5ddb55 The arguments of Epub3Builder.build_navigation_doc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
b6c422ac86 The arguments of EpubBuilder.build_epub() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
64533e142c The arguments of EpubBuilder.build_toc() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
d437f39bc4 The arguments of EpubBuilder.build_content() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
f000df8bfb The arguments of EpubBuilder.build_container() is deprecated. 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
0f972e8bbf The arguments of EpubBuilder.build_mimetype() is deprecated 2019-01-09 00:10:36 +09:00
Takeshi KOMIYA
39c0380c4d refactor: deprecate some pycompat functions 2019-01-07 22:54:37 +09:00
Takeshi KOMIYA
353c3e9fd6
Merge pull request #5415 from tk0miya/5410_replace_open_file_by_open 
refactor: Repalce HTMLHelpBuilder.open_file() by standard open()
 2019-01-07 00:59:03 +09:00
Takeshi KOMIYA
56f4b27faa Deprecate LaTeXTranslator.generate_numfig_format() 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
45d04703fe latex: Move ExtBabel to sphinx.builders.latex.util package 2019-01-04 23:06:34 +09:00
Takeshi KOMIYA
3c7b4e77e0 refactor: Repalce HTMLHelpBuilder.open_file() by standard open() 2019-01-03 02:05:32 +09:00
jfbu
b62bf0e0fc Redo spelling fix lost in merge (contents moved to other file) 
modified:   doc/extdev/index.rst
 2018-12-28 16:03:26 +01:00
jfbu
32d57b8637 Merge branch '1.8' 
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
 2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
Takeshi KOMIYA
55a89196e4
Merge pull request #5678 from ArtFlag/docs/extension-tutorials 
Docs: Extension tutorial portal + helloworld example
 2018-12-23 22:55:24 +09:00
ArtFlag
35b62e21c9 Move content from the todo tutorial to the extdev/index 2018-12-22 11:38:12 +01:00
jfbu
f8389f5181 [DOC] Make link to list of deprecated APIs in CHANGES an internal link 2018-12-20 21:18:37 +01:00
Takeshi KOMIYA
6fe57436a8
Merge pull request #5839 from jdufresne/description 
Deprecate unused Exception attributes
 2018-12-20 10:15:06 +09:00
ArtFlag
870e2bbc1c move files to new directory 2018-12-19 17:35:17 +01:00
Takeshi KOMIYA
d0f5862597 Replace EnvironmentError and IOError by OSError 
Since python 3.3, EnvironmentError and IOError were merged into
OSError.
 2018-12-19 19:26:50 +09:00
Jon Dufresne
e9eaf41a58 Deprecate unused Exception attributes 
The attributes were used only for the string representation, but that is
also the default behavior of the Exception class. Observe:

>>> str(Exception('foo'))
'foo'
>>> print(Exception('foo'))
foo
 2018-12-18 18:32:16 -08:00
Takeshi KOMIYA
9574607578
Merge pull request #5827 from tk0miya/refactor_io3 
Refactor sphinx.io
 2018-12-18 23:28:50 +09:00
Jon Dufresne
43ff640b58 Deprecate quickstart.term_decode() and remove internal uses 
Per the Python 3 docs, input() always returns a string:

https://docs.python.org/3/library/functions.html#input

> The function then reads a line from input, converts it to a
> string (stripping a trailing newline), and returns that.

The stubs from typeshed say the same:

5c69373890/stdlib/3/builtins.pyi (L835)

Here is the implementation from CPython with also shows a call to
PyUnicode_Decode on the result:

https://github.com/python/cpython/blob/3.7/Python/bltinmodule.c#L1960-L2143

As the value is always a string, there is nothing to decode. Therefore
the call to term_decode() unnecessary and can safely be removed.

With this in mind, must adjust quickstart tests to be more
representative.
 2018-12-17 06:44:17 -08:00
Takeshi KOMIYA
f3350b8b7d Deprecate SphinxFileInput.supported 2018-12-17 22:26:29 +09:00
Takeshi KOMIYA
636ca67528 Deprecate SphinxBaseFileInput 2018-12-17 22:08:00 +09:00
Takeshi KOMIYA
de49b991f6 refactor: Use simple Input class 2018-12-17 22:07:56 +09:00
Takeshi KOMIYA
71a7ce1453
Merge branch 'master' into string-classes 2018-12-17 18:58:32 +09:00
Jon Dufresne
c4baa7234e Deprecate the old IndexBuilder.feed() method signature 
The method signature changed in commit
d27386cc95 (Jun 8, 2016).
 2018-12-16 13:52:56 -08:00
Jon Dufresne
80861d105b Deprecate sphinx.config.string_classes; remove all internal uses 
With only a single text type across supported Python versions, the
string_classes is no longer necessary.

Internally, all uses were converted to the value `[str]`. For
.add_config_value() uses that also supply a default string, the type is
inferred.
 2018-12-16 11:35:06 -08:00
Takeshi KOMIYA
6461ea233b
Merge pull request #5793 from tk0miya/pretty_changes 
Pretty changes
 2018-12-16 23:13:37 +09:00
Takeshi KOMIYA
1bf9a7eac5 Deprecate LaTeXTranslator.collect_footnotes() 2018-12-16 21:52:30 +09:00
Takeshi KOMIYA
cdb36fbbf6 Sort deprecated APIs by version 2018-12-16 21:51:33 +09:00
Takeshi KOMIYA
048cfb5e0a Deprecate UnicodeMixin 2018-12-16 21:51:18 +09:00
Jon Dufresne
49d3a3c0c1 Replace ENOENT errno checks with Python 3 FileNotFoundError 
The error is more specific and self documenting.

This removes the last use of sphinx.util.osutil.ENOENT, so it is now
deprecated for removal. sphinx.util.osutil.EEXIST was already unused so
that is deprecated as well.
 2018-12-15 09:02:55 -08:00
Takeshi KOMIYA
6b24c069c3 Deprecate sphinx.util.inspect.Parameter 2018-12-15 21:44:17 +09:00
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
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
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
Ignacio Fdez. Galván
d5cbda5c79 Merge remote-tracking branch 'upstream/master' 2015-07-09 17:35:23 +02:00
Jean Jordaan
56c51ff4b0 Some language edits while reading 2015-05-15 13:18:19 +08:00
Ignacio Fdez. Galván
204b9cc521 Changed 'rel' to 'alternate' 2015-03-12 10:51:45 +01:00
Ignacio Fdez. Galván
a18c04b955 Allow setting 'rel' and 'title' attributes for stylesheets. 2015-03-11 15:48:40 +01:00
Georg Brandl
accb32ff07 The `env-updated` event can now return a value, which is interpreted as an iterable of additional docnames that need to be rewritten. 
(reference: #1683)
 2015-01-25 16:13:04 +01:00
Takayuki Shimizukawa
aa79c97da7 merge with stable 2014-12-05 19:44:05 +09:00
Takayuki Shimizukawa
6993a7254c fix documentation for extension development tutorial. Closes #1624. Thanks to dkeeney_fastacash. 2014-11-26 20:14:31 +09:00
Georg Brandl
96ce3b1374 Closes #1597: Added possibility to return a new template name from html-page-context. 2014-10-23 07:58:23 +02:00
Takayuki Shimizukawa
da651089e7 fix trailing space and long line 2014-10-09 23:53:33 +09:00
tk0miya
16529c5604 Add options argument to Sphinx.add_latex_package() 2014-09-28 21:10:26 +09:00
tk0miya
c04ad2908e Add new API: Sphinx.add_latex_package() 
Sphinx.add_latex_package() allows sphinx extensions to add latex packages.
It helps creating extensions for latex (for example, latex-theming)
 2014-09-27 12:47:27 +09:00
Georg Brandl
e3135cfc87 Make remaining builtin extensions parallel-read-proof. 2014-09-22 22:05:03 +02:00
Georg Brandl
52e5316b6e Document env-merge-info event, add parallel reading to changelog 2014-09-22 21:55:11 +02:00
Georg Brandl
31452fc64d [WIP] parallel read 2014-09-22 14:51:47 +02:00
Georg Brandl
71cd2f7e50 Change extension setup() return value to a dictionary of metadata. 
This makes it possible to introduce more metadata values later.
 2014-09-22 11:06:42 +02:00
Georg Brandl
e7ed7cd627 Rename env-read-docs to env-before-read-docs, add changelog entry and fixup tests. 2014-09-22 09:13:44 +02:00
Georg Brandl
3c5cda97d1 Merged in guillemNaN/sphinx (pull request #261) 
Add env-read-docs event to allow modify docnames list before processing
 2014-09-22 09:05:00 +02:00
Georg Brandl
b6594d18d1 Add support for extensions to declare their version as a string returned from setup(). 2014-09-03 16:27:15 +02:00
Takayuki Shimizukawa
f7399a261a Add app.set_translator() API to register or override a Docutils translator class like :confval:html_translator_class. 2014-08-05 00:18:54 +09:00
Takayuki Shimizukawa
2e1c16486c * fix code to pass test, add versionadded to doc, update CHANGES for pull request #229 2014-08-03 19:19:31 +09:00
Takayuki Shimizukawa
9191ffaa50 Merged in russell/sphinx-pluggable-translators (pull request #229) 
Allow registration of other translators
 2014-08-03 18:52:02 +09:00
Guillem Barba
b4b15181b4 Add env-read-docs event to allow modify docnames list before processing 2014-07-31 18:28:47 +02:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Jean-Paul Calderone
19533c96a5 Fix a copy/paste (presumably) mistake in the extdev tutorial. 2014-04-04 11:53:37 -04:00
Georg Brandl
04065625ed merge with stable 2014-03-26 07:30:55 +01:00
Georg Brandl
c24cfbaed1 Add an example how to connect events. 2014-03-26 07:30:48 +01:00
Russell Sim
45a0bcd453 Allow registration of other translators 
This adds an add_translator method to the sphinx application class.
It allows developers to register custom translators (writers) with
sphinx, so other extensions that add new nodes can register support
for the custom translators.
 2014-03-20 12:34:11 +11:00
Georg Brandl
85ddf03f45 merge with stable 2014-03-02 08:50:10 +01:00
Georg Brandl
501c2d13e6 Fix long lines. 2014-03-02 08:40:48 +01:00
Georg Brandl
eb79fcafea merge with stable 2014-01-26 11:51:09 +01:00
Georg Brandl
25ac2dda9c add link 2014-01-24 20:22:58 +01:00
Georg Brandl
1eb23c62ce merge with stable 2014-01-22 18:13:49 +01:00
Georg Brandl
fb5a1a09a0 some directive creation docs 2014-01-21 10:32:30 +01:00
Georg Brandl
6b33e3fea4 remove duplicate wording 2014-01-21 10:05:23 +01:00
Georg Brandl
cc8d29dcab actually use exception markup 2014-01-21 10:04:11 +01:00
Georg Brandl
da09100869 doc: add exceptions from sphinx.errors 2014-01-21 09:54:31 +01:00
Georg Brandl
317930a7fb merge with stable 2014-01-20 21:21:33 +01:00
Georg Brandl
883324fd6c Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00