3106 Commits

Author	SHA1	Message	Date
Takeshi KOMIYA	6007bbf797	Deprecate DocumenterBridge.warn() ... Since 1.6, sphinx.util.logging module became the default logging interface of Sphinx. It allows sphinx-components to output log without the app (or env) object. According to the policy, DocumenterBridge.warn() is no longer needed and should be replaced by the logging module.	2021-03-22 23:51:54 +09:00
Takeshi KOMIYA	cb654d287b	Rename DocumenterBridge.filename_set to record_dependencies ... DocumenterBridge.filename_set has been used since its beginning. On the other hand, in docutils, record_dependencies attribute is well-used to store the list of dependency files. So this renames it to docutils' standard attribute.	2021-03-21 00:52:53 +09:00
Takeshi KOMIYA	45f56dd7ac	Fix #9008: Fix typo	2021-03-16 01:28:07 +09:00
Takeshi KOMIYA	e03d0aeba0	Merge pull request #8991 from tk0miya/typing_OptionSpec ... refactor: Add a type alias for the option_spec of directives; OptionSpec	2021-03-15 13:03:15 +09:00
Tim Hoffmann	0d73a03a38	DOC: Minor cleanup of sphinx-build doc ... The moved sentence clearly belongs to the discussion of the builders.	2021-03-15 00:27:39 +01:00
Takeshi KOMIYA	17bb78997c	Merge pull request #7298 from tk0miya/7068_pyproperty_directive ... py domain: Add py:property directive to describe a property (refs: #7068)	2021-03-13 21:22:29 +09:00
Takeshi KOMIYA	a523a89663	refactor: Add a type alias for the option_spec of directives; OptionSpec	2021-03-13 17:15:12 +09:00
Jean-François B	1a62d89276	Merge branch 'master' into pdf_bookmarksdepth	2021-03-12 21:57:45 +01:00
Takeshi KOMIYA	204f86f736	py domain: Add py:property directive to describe a property (refs: #7068)	2021-03-11 01:56:39 +09:00
Takeshi KOMIYA	54886fd256	Close #7549: autosummary: Enable autosummary_generate by default	2021-03-10 01:35:49 +09:00
Takeshi KOMIYA	3693ffe232	Merge pull request #8972 from igo95862/master ... Tutorial for extending autodoc	2021-03-10 01:20:05 +09:00
igo95862	7ee2000598	doc: Added reflink to autodoc tutorial ... Used in add_autodocumenter docstring	2021-03-09 17:57:30 +03:00
igo95862	a56f69b916	doc: Added autodoc extension tutorial to tutorials index	2021-03-09 17:57:30 +03:00
igo95862	1ac05a2a83	doc: Create autodoc extension tutorial	2021-03-09 17:56:46 +03:00
Takeshi KOMIYA	fb4220d0a2	Close #8487: csv-table now considers abspath as relpath from srcdir ... To make directives' behavior consistent, the :file: option for csv-table directive now recognizes an absolute path as a relative path from source directory.	2021-03-09 01:07:19 +09:00
Takeshi KOMIYA	ae413e95ed	Merge pull request #8970 from naveen521kk/patch-1 ... Sphinx is available on Chocolatey	2021-03-07 21:30:46 +09:00
Naveen M K	1b425230e3	lint	2021-03-07 00:21:41 +05:30
Naveen M K	2638e9aecc	Sphinx is available on Chocolatey	2021-03-07 00:13:40 +05:30
Takeshi KOMIYA	0dcdbdc230	doc: Fix indentation	2021-03-06 21:19:26 +09:00
Takeshi KOMIYA	008feac9ad	Merge pull request #8965 from tk0miya/refactor_doc ... doc: Update document for autodoc	2021-03-06 20:15:24 +09:00
Takeshi KOMIYA	697fdea612	doc: Update document for autodoc :special-members: option	2021-03-06 19:12:52 +09:00
Takeshi KOMIYA	8411b9a536	doc: Update document for autodoc :private-members: option	2021-03-06 19:12:47 +09:00
Takeshi KOMIYA	009fd4c396	doc: Update document for autodoc :undoc-members: option	2021-03-06 19:12:41 +09:00
Takeshi KOMIYA	f37e679fd1	doc: Update document for autodoc :members: option	2021-03-06 19:12:34 +09:00
Takeshi KOMIYA	1ea11b1e48	Fix #759: autodoc: Add sphinx.ext.autodoc.preserve_defaults extension ... Add a new extension `sphinx.ext.autodoc.preserve_defaults`. It preserves the default argument values of function signatures in source code and keep them not evaluated for readability. This is an experimental extension and it will be integrated into autodoc core in Sphinx-4.0.	2021-03-06 18:48:18 +09:00
Takeshi KOMIYA	0a3f897d15	Merge pull request #8432 from tk0miya/7119_pending_xref_condition ... Fix #7119: Show type hint names unqualified when resolving succeeded	2021-03-06 17:32:27 +09:00
Takeshi KOMIYA	930a880294	Fix #7199: py domain: Add a new confval: python_use_unqualified_type_names ... Add a new config variable: python_use_unqualified_type_names. If enabled, it goes to suppress the module name of the python reference if it can be resolved.	2021-03-06 14:00:00 +09:00
Takeshi KOMIYA	e1130972b2	Add pending_xref_condition node ... To choose appropriate content for pending_xref node on resolving, this introduces a new custom node `pending_xref_condition`. It only has a condition for the filtering and contents of the reference.	2021-03-06 02:01:03 +09:00
Takeshi KOMIYA	ff49bfa003	Merge pull request #8947 from tk0miya/deprecate_registry.get_source_input ... Deprecate SphinxComponentRegistry.get_source_input()	2021-03-05 00:06:05 +09:00
Takeshi KOMIYA	61c9c7fc58	Deprecate SphinxComponentRegistry.get_source_input() ... The source_input system was deprecated at v2.0. So no client uses it longer now. Therefore this deprecate the getter interface and its usage.	2021-03-02 21:18:31 +09:00
Takeshi KOMIYA	3059a999b2	Close #8326: Rename master_doc to root_doc ... To describe the purpose more accurately, the `master_doc` is now renamed to `root_doc`. The old name is still available. But it is recommeneded to use new one from now on.	2021-02-28 17:10:57 +09:00
jfbu	ddef4950ee	LaTeX: let bookmarks use high default depth ... Add bookmarksdepth key to latex_elements['sphinxsetup']	2021-02-18 13:11:28 +01:00
jfbu	62401ef1ec	Merge branch '3.x'	2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen	a7fcc15683	C++, add noroot option to alias directive	2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen	06a956200b	C, add noroot option to alias directive	2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen	d0a4d0147e	C++, add recursiveness to alias ... Fixes sphinx-doc/sphinx#8213 in the most basic way.	2021-02-12 17:25:12 +01:00
Takeshi KOMIYA	61af7f48ad	Merge pull request #8873 from tk0miya/8860_bad_example ... Fix #8860: doc: Usage of recipe directive is wrong	2021-02-13 01:04:27 +09:00
Takeshi KOMIYA	def6f13d8d	Merge branch '3.x'	2021-02-13 01:01:30 +09:00
Takeshi KOMIYA	3b451bbcde	Merge pull request #8835 from tk0miya/refactor_linkcheck7 ... refactor: linkcheck: Separate thread manager feature from builder class	2021-02-12 23:32:30 +09:00
Takeshi KOMIYA	5c223d20d6	refactor: linkcheck: Separate thread manager feature from builder class ... To reduce the complexity of the linkcheck builder, this separates the thread manager feature from the builder class as HyperlinkAvailabilityChecker.	2021-02-12 23:19:01 +09:00
Takeshi KOMIYA	d5de7bf3cf	Fix #8860: doc: Usage of recipe directive is wrong	2021-02-12 20:51:53 +09:00
Takeshi KOMIYA	f17ab57b64	Fix #8860: doc: recipe directive crashes with AttributeError ... The pre check in the `ReceipeDirective.add_target_and_index() was wrong. It checkes non-existing option "noindex", but it should check "contains" option instead.	2021-02-11 22:13:07 +09:00
jfbu	b9c53c8ca6	Merge branch '3.x' into merge_3.x_into_master ... Resolved Conflicts: sphinx/texinputs/sphinx.sty Some hunks needed to go to sphinx/texinputs/sphinxlatexliterals.py, others already belonged to split files.	2021-02-09 19:03:38 +01:00
jfbu	87d0b15eab	Also indent warning to not interrupt description list	2021-02-09 18:29:56 +01:00
jfbu	a310c4c5b6	Indent note directive inside list item	2021-02-09 18:25:37 +01:00
jfbu	32d8b4e445	Minor refactoring in doc/latex.rst	2021-02-09 18:11:24 +01:00
Jean-François B	1c08467040	Merge pull request #8851 from jfbu/latex_enhance_docs_about_index ... LaTeX: improve docs of 'printindex' and 'makeindex'	2021-02-09 16:16:26 +01:00
Jean-François B	86ea2a93e0	Merge pull request #8854 from jfbu/latex_longstringsincodeblocks ... LaTeX: optionally apply a second forceful wrapping of long code lines	2021-02-09 16:14:48 +01:00
jfbu	aaac721104	Typo	2021-02-09 16:04:01 +01:00
jfbu	035d13fd24	Update CHANGES and docs relative to new verbatimforcewraps	2021-02-09 15:47:15 +01:00