Commit Graph

17207 Commits

Author SHA1 Message Date
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
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
Jakob Lykke Andersen
58b6b45993 C, fix linking of names in array declarators 2021-03-14 10:25:29 +01:00
Jakob Lykke Andersen
57220411da C++, fix linking in some declarators 2021-03-14 10:11:03 +01:00
Jakob Lykke Andersen
e45d0797cb C++, always try to resolve name in sizeof... 2021-03-13 20:01:25 +01:00
jfbu
9a4b4b5934 Update CHANGES 2021-03-13 16:57:06 +01:00
jfbu
b6d143118d LaTeX: modify \pysigline and \pysiglinewithargsret
Fix #7241
Fix #8980
Fix #8995
2021-03-13 16:56:50 +01:00
Takeshi KOMIYA
6c7480b3f6 Fix #7119: autodoc: Broken doctree was generated by builtin_resolver
The builtin_resolver() generates broken doctree unexpectedly if it
contains pending_xref_condition nodes.
2021-03-14 00:10:00 +09:00
Takeshi KOMIYA
75f5122996 Fix #7383: autodoc: Support typehints for properties
py:property directive now outputs py:property directive to describe
its type annotation.
2021-03-13 22:51:46 +09: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
Takeshi KOMIYA
aeb9e42d2b refactor: Use PEP-526 based variable annotation (sphinx.builders) 2021-03-13 16:37:50 +09:00
Takeshi KOMIYA
c817c20626
Merge pull request #8984 from tk0miya/refactor_vartypes_writers
refactor: Use PEP-526 based variable annotation (sphinx.writers)
2021-03-13 16:30:04 +09:00
Takeshi KOMIYA
dd24a4ef2d refactor: Use PEP-526 based variable annotation (sphinx.writers) 2021-03-13 16:20:09 +09:00
Takeshi KOMIYA
2e43197601
Merge pull request #8986 from webknjaz/bugfixes/8985-new-style-intersphinx-mapping
Make `conf.py` template use new-style interpshinx
2021-03-13 12:53:28 +09:00
Jean-François B
796d36fd62
Merge pull request #8907 from jfbu/pdf_bookmarksdepth
LaTeX: let bookmarks use high default depth
2021-03-12 22:15:35 +01:00
Jean-François B
ebce50dfed
Merge branch 'master' into pdf_bookmarksdepth 2021-03-12 21:59:04 +01:00
Jean-François B
3bbdc65451
Merge pull request #8879 from jfbu/latex_better_fix_pygments
LaTeX: better workaround for a Pygments LaTeXFormatter issue (with Pygments up to 2.7.4)
2021-03-12 21:58:01 +01:00
Jean-François B
1a62d89276
Merge branch 'master' into pdf_bookmarksdepth 2021-03-12 21:57:45 +01:00
Jean-François B
4c8418b58c
Merge branch 'master' into latex_better_fix_pygments 2021-03-12 21:48:34 +01:00
Sviatoslav Sydorenko
1232a14de8
Make conf.py template use new-style interpshinx
Fixes #8985
2021-03-12 00:49:49 +01:00
Takeshi KOMIYA
4bb151bf36
Merge pull request #8976 from tk0miya/refactor_vartypes_util
refactor: Use PEP-526 based variable annotation (sphinx.util)
2021-03-12 01:52:19 +09: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
e1a02dc4e7
Merge pull request #7550 from tk0miya/7549_enable_autosummary_generate
Close #7549: autosummary: Enable autosummary_generate by default
2021-03-10 01:50:08 +09:00
Takeshi KOMIYA
6976c051ee refactor: Use PEP-526 based variable annotation (sphinx.util) 2021-03-10 01:49:31 +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
c57cb0b5ed doc: Link autodoc tutorial in add_autodocumenter docstring
Uses :ref: link because :doc: does not work.
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
426fa9d00d
Merge pull request #8969 from tk0miya/8487_absoluted_file_option_for_csv_table
Close #8487: csv-table now considers abspath as relpath from srcdir
2021-03-09 01:49:31 +09: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
0c76c1abcf
Merge pull request #8968 from tk0miya/fix_typo
Fix wrong directive name in warning messages
2021-03-07 00:54:07 +09:00