Commit Graph

17242 Commits

Author SHA1 Message Date
Brecht Machiels
ac0dcddeb8
Docs: fix typo in env-merge-info 2021-03-30 16:44:50 +02:00
Takeshi KOMIYA
e888a44249
Merge pull request #9026 from tk0miya/5603_autodoc_canonical
Close #5603: autodoc: Allow to refer to a python object using canonical name
2021-03-27 17:45:38 +09:00
Takeshi KOMIYA
acf66bc4d5 Close #5603: autodoc: Allow to refer to a python object using canonical name
This generates `:canonical:` option for `:py:class:` directive if the
target class is imported from other module.  It allows users to refer it
using both the new name (imported name) and the original name (canonical
name).

It helps a library that implements some class in private module (like
`_io.StringIO`), and publish it as public module (like `io.StringIO`).
2021-03-27 17:34:15 +09:00
Takeshi KOMIYA
cd75f8fea1 Merge branch '3.x' 2021-03-27 17:33:49 +09:00
Takeshi KOMIYA
b342300c5e Merge branch '3.5.x' into 3.x 2021-03-27 17:30:50 +09:00
Takeshi KOMIYA
6a873cae0b
Merge pull request #9038 from tk0miya/fix_linkcheck_ci
Fix the testcase for linkcheck refers removed URLs
2021-03-27 17:25:58 +09:00
Takeshi KOMIYA
26d9a8962e Fix the testcase for linkcheck refers removed URLs
Some public URLs are disabled now.
For more details, see https://github.com/sphinx-doc/sphinx/issues/8309
2021-03-27 17:10:09 +09:00
Takeshi KOMIYA
06c59d2723
Merge pull request #9033 from stratakis/typos
Fix some local parameter names
2021-03-27 00:47:43 +09:00
Takeshi KOMIYA
d27bdce2d7
Merge pull request #9031 from tk0miya/refactor_vartypes_env
refactor: Use PEP-526 based variable annotation (sphinx.environment)
2021-03-27 00:36:24 +09:00
Takeshi KOMIYA
1b66532c0e
Merge branch 'master' into typos 2021-03-27 00:34:41 +09:00
Charalampos Stratakis
2a90b28d61 Fix some local parameter names 2021-03-25 18:17:45 +01:00
Takeshi KOMIYA
000ae2e500 refactor: Use PEP-526 based variable annotation (sphinx.environment) 2021-03-25 00:10:31 +09:00
Takeshi KOMIYA
6e4df0a419
Merge pull request #9029 from tk0miya/refactor_vartypes_transforms
refactor: Use PEP-526 based variable annotation (sphinx.transforms)
2021-03-25 00:08:29 +09:00
Takeshi KOMIYA
7e6ea15b68 refactor: Use PEP-526 based variable annotation (sphinx.transforms) 2021-03-24 23:35:19 +09:00
Takeshi KOMIYA
141735f90c
Merge pull request #9028 from tk0miya/refactor_vartypes_directives
refactor: Use PEP-526 based variable annotation (sphinx.directives)
2021-03-24 23:34:28 +09:00
Takeshi KOMIYA
555a52be82 refactor: Use PEP-526 based variable annotation (sphinx.directives) 2021-03-23 01:44:24 +09:00
Takeshi KOMIYA
09a037006c
Merge pull request #9017 from tk0miya/refactor_vartypes_domains
refactor: Use PEP-526 based variable annotation (sphinx.domains)
2021-03-23 01:43:15 +09:00
Takeshi KOMIYA
035019629a refactor: Use PEP-526 based variable annotation (sphinx.domains) 2021-03-23 01:33:32 +09:00
Takeshi KOMIYA
751622c1b9
Merge pull request #9022 from tk0miya/deprecate_DocumenterBridge.warn
Deprecate DocumenterBridge.warn()
2021-03-23 01:32:05 +09:00
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
f60ee524ba
Merge pull request #9021 from tk0miya/deprecate_DocumenterBridge.filename_set
Rename DocumenterBridge.filename_set to record_dependencies
2021-03-22 23:50:03 +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
5e8f814e81 Merge branch '3.x' 2021-03-20 23:25:57 +09:00
Takeshi KOMIYA
82f495fed3 Merge branch '3.5.x' into 3.x 2021-03-20 23:07:44 +09:00
Takeshi KOMIYA
14ff1bcf72 Bump version 2021-03-20 23:07:26 +09:00
Takeshi KOMIYA
1aca32cfd1 Bump to 3.5.3 final 2021-03-20 23:03:15 +09:00
Takeshi KOMIYA
11144ea009
Merge pull request #8967 from tk0miya/8959_unix_pathsep_on_windows
Fix #8959: using UNIX path separator confuses Sphinx on Windows
2021-03-20 22:53:32 +09:00
Takeshi KOMIYA
a19250b46e Fix #8959: using UNIX path separator confuses Sphinx on Windows
The first element of env.relfn2path() should be a POSIX path, not a OS
dependent path.
2021-03-20 01:32:47 +09:00
Takeshi KOMIYA
560def9606
Merge pull request #9015 from tk0miya/8992_types.TracebackType
Fix #8992: autodoc: Failed to resolve types.TracebackType type annotation
2021-03-18 23:49:54 +09:00
Takeshi KOMIYA
8c7e779731 Fix #8992: autodoc: Failed to resolve types.TracebackType type annotation
The builtin module, ``types.TracebackType`` does not have correct module
name.  This allows to refer it automatically.
2021-03-17 23:37:43 +09:00
Takeshi KOMIYA
9f62b9cccb
Merge pull request #9011 from tk0miya/9009_unescaped_release_in_latex
Fix #9009: LaTeX: "release" value with underscore leads to invalid LaTeX
2021-03-17 01:46:06 +09:00
Takeshi KOMIYA
0c68b0866e
Merge pull request #9004 from tk0miya/refactor_vartypes_ext
refactor: Use PEP-526 based variable annotation (sphinx.ext)
2021-03-17 01:28:16 +09:00
Takeshi KOMIYA
659fdc63e5
Merge pull request #9010 from tk0miya/9008_fix_typo
Fix #9008: Fix typo
2021-03-17 01:25:24 +09:00
Takeshi KOMIYA
3937ea816f Fix #9009: LaTeX: "release" value with underscore leads to invalid LaTeX
The "release" variable is not escaped on the LaTeX output.
2021-03-17 01:24:03 +09:00
Takeshi KOMIYA
45f56dd7ac Fix #9008: Fix typo 2021-03-16 01:28:07 +09:00
Jean-François B
d79d041f4f
Merge pull request #9006 from jfbu/latex_pysigline_fix_stacked_labels
LaTeX: partially revert #8997 for \pysigline
2021-03-15 16:28:18 +01:00
jfbu
7e0295dbd7 LaTeX: partially revert #8997 \pysigline
Reason is that mark-up such as this:

   .. attribute:: state
                  state_machine

      The state and state machine which controls the parsing.  Used for
      ``nested_parse``.

generates two `\pysigline` each with `\phantomsection`. The latex code
to get good vertical spacing between label and its description, if label
``\parbox`` is multi-line, cause in this context the two (generally,
single-line) labels to be stacked vertically with no spacing.

This commit keeps the ``\parbox`` which fixes #8980, but drops the
attempt to correct vertical distance to description, so as to not alter
the possibly more common use case of items with common description.
2021-03-15 11:18:13 +01:00
Takeshi KOMIYA
1d4c414319 refactor: Use PEP-526 based variable annotation (sphinx.ext) 2021-03-15 13:11:07 +09:00
Takeshi KOMIYA
f8e7ecf10b
Merge pull request #8983 from tk0miya/7523_autodoc_property
Fix #7383: autodoc: Support typehints for properties
2021-03-15 13:04:01 +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
Takeshi KOMIYA
3987e64263
Merge pull request #8990 from tk0miya/refactor_vartypes_builders
refactor: Use PEP-526 based variable annotation (sphinx.builders)
2021-03-15 13:01:17 +09:00
Takeshi KOMIYA
8c9751eb27
Merge pull request #9002 from timhoffm/doc-sphinx-build
DOC: Minor cleanup of sphinx-build doc
2021-03-15 12:16:58 +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
Jean-François B
2934aac441
Merge pull request #8997 from jfbu/latex_pysigline
LaTeX: improve behavious of `\pysigline` and `\pysiglinewithargsret` in case of multi-line signature
2021-03-14 21:35:17 +01:00
Jean-François B
64ad5b5154
Merge pull request #9000 from jfbu/latex_2021_par
Refactor some internal LaTeX code
2021-03-14 21:34:38 +01:00
Takeshi KOMIYA
4915ea6f71
Merge pull request #8996 from tk0miya/7119_pending_xref_conditions
Fix #7119: autodoc: Broken doctree was generated by builtin_resolver
2021-03-15 01:10:52 +09:00
Takeshi KOMIYA
5b5730ef4e Avoid a mypy warning 2021-03-15 00:46:19 +09:00
jfbu
5e0e6c8898 Refactor some internal LaTeX code
Codeline wrapping in literal blocks (possibly hard-wrap in presence of
unbreakable long strings) requires a measurement step. Spring 2021 LaTeX
adds quite some overhead to each and every paragraph to insert hooks at
begin and end of paragraphs. For technical reasons, our measurement
(which uses a paragraph in a scratch box) could be broken by the "after
para" hook. Work around that.
2021-03-14 11:55:51 +01:00
Jakob Lykke Andersen
c89bda11d1
Merge pull request #8999 from jakobandersen/c_cpp_render_fixes
C, C++ render fixes
2021-03-14 10:45:12 +01:00
Jakob Lykke Andersen
dfc759e039 Missing CHANGES item 2021-03-14 10:29:06 +01:00