Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ENH: enable multiline signatures when too long. #11011

Merged
merged 110 commits into from May 11, 2023
Merged

ENH: enable multiline signatures when too long. #11011

Changes from 1 commit
Commits
Show all changes
110 commits
Select commit Hold shift + click to select a range
82f1b98
ENH: enable multiline signatures when too long.
TLouf Dec 3, 2022
8d6dfba
Make parameter nodes inherit from sig classes
TLouf Dec 17, 2022
581433b
Fix permalink for multiline Python signatures
TLouf Dec 17, 2022
d3ec233
Enable multiline sig for C and C++
TLouf Dec 17, 2022
1229b66
Simplify `desc_parameterlist` into single class
TLouf Dec 26, 2022
ec713e9
Fix flake8 errors
TLouf Dec 26, 2022
85ff493
Pass multiline as `desc_parameterlist` attribute
TLouf Dec 26, 2022
8ca560d
Add type annotation
TLouf Dec 26, 2022
9ec4698
Use new desc_parameterline instead of desc_content
TLouf Dec 28, 2022
b93ecf0
Support HTML writer
TLouf Dec 28, 2022
3b110ce
Support text writer
TLouf Dec 28, 2022
234acd6
Increment environment versions
TLouf Dec 29, 2022
7c016c9
Better variable names
TLouf Dec 30, 2022
5b8735d
Expand docstrings of new nodes' classes
TLouf Dec 30, 2022
1ca68b0
Fix oversight of param line name change in C++
TLouf Jan 3, 2023
8e198f3
Add newlines to make param list HTML prettier
TLouf Jan 3, 2023
25ae353
Tweak EPUB's CSS to match HTML's
TLouf Jan 3, 2023
d6b2dac
Add tests for python domain
TLouf Jan 3, 2023
af77cad
Add tests for C domain
TLouf Jan 3, 2023
ea89180
Add tests for C++ domain
TLouf Jan 3, 2023
5cc07d6
Add minimal implementation for man and texinfo
TLouf Jan 3, 2023
caff655
Python domain test cleanup
TLouf Jan 3, 2023
b71b06d
Make flake8 happy
TLouf Jan 3, 2023
88c2e09
Make isort happy
TLouf Jan 3, 2023
4258fd5
Add doc
TLouf Jan 3, 2023
6e6261c
Make docslint happy
TLouf Jan 3, 2023
9c52eae
Add types for `maximum_signature_line_length`
TLouf Jan 8, 2023
2d9ad80
Fix typo
TLouf Jan 8, 2023
0bc3b68
Add global `maximum_signature_line_length` config
TLouf Jan 8, 2023
2c0da6a
Add tentative LaTeX implementation
TLouf Jan 20, 2023
bba2b51
Merge branch 'master' into signature-linebreaks
TLouf Jan 20, 2023
d8df099
Make docslint happy
TLouf Jan 20, 2023
d18f973
Merge branch 'master' into signature-linebreaks
jfbu Jan 23, 2023
d803e68
Cleanup latex style
TLouf Jan 23, 2023
3753e7e
Rename new latex command for clarity
TLouf Jan 23, 2023
eb63da6
Force zero margins for dl tag
TLouf Jan 23, 2023
53e882f
latex: avoid page break above first function argument
TLouf Jan 24, 2023
d7508a0
latex: match coding style of LaTeX macro files in for loop
TLouf Jan 24, 2023
b665647
latex: rename command to `pysigwithonelineperarg`
TLouf Jan 24, 2023
ada9d00
latex: avoid page break before dedented closing brace
TLouf Jan 24, 2023
ed7fac8
Update versionadded
TLouf Jan 24, 2023
1475f5f
docs: fix linking to `single-line-signature`
TLouf Jan 24, 2023
9b9e694
docs: better linking to `single-line-signature`
TLouf Jan 25, 2023
691a780
Merge branch 'master' into signature-linebreaks
TLouf Apr 7, 2023
4deb58c
Add trailing commas for ruff
TLouf Apr 7, 2023
48d2ccb
Add trailing commas in tests
TLouf Apr 7, 2023
b065ab7
Add `desc_parameter_line` to doc
TLouf Apr 7, 2023
8d42ac1
Merge branch 'master' into signature-linebreaks
AA-Turner Apr 7, 2023
2b864fe
Update config docs
AA-Turner Apr 8, 2023
fa97a15
Update option docs
AA-Turner Apr 7, 2023
d787002
Move options to end
AA-Turner Apr 8, 2023
707650f
Revert changes to the frozen HTML 4 writer
AA-Turner Apr 7, 2023
b1cb1b3
Revert ``is_multiline`` -> ```is_multi_line`` rename for ``desc_signa…
AA-Turner Apr 7, 2023
8308742
``maximum_signature_line_length`` type to be int | None
AA-Turner Apr 7, 2023
e6ef3c2
Rename ``single-line-signature`` to ``single-line-{parameter,argument…
AA-Turner Apr 8, 2023
dfd0075
Refactor tests
AA-Turner Apr 8, 2023
bfab7ea
Set and use ``multi_line_parameter_list`` on node
AA-Turner Apr 7, 2023
26551bc
Remove ``desc_parameter_line``
AA-Turner Apr 8, 2023
9d03de0
options docs typo (macro -> function)
AA-Turner Apr 8, 2023
b3e5662
CHANGES entry
AA-Turner Apr 8, 2023
592c86c
fixup! Remove ``desc_parameter_line``
AA-Turner Apr 8, 2023
1af1a2e
Restore stripped whitespace
AA-Turner Apr 8, 2023
69dba4b
fixup! (round 2) Remove ``desc_parameter_line``
AA-Turner Apr 8, 2023
2918995
Remove unneeded py domain permalink logic
AA-Turner Apr 8, 2023
d58b63c
Restore cross-reference to single line option
TLouf Apr 8, 2023
b866b88
Add JS domain implentation
TLouf Apr 8, 2023
c6cf460
Mention @jfbu in CHANGES
TLouf Apr 9, 2023
b18c481
Unify directive option to `single-line-parameter-list`
TLouf Apr 9, 2023
4b47e79
Fix directive hyperlink in CHANGES
TLouf Apr 9, 2023
a652d3e
Pass multiline bool to `_pseudo_parse_arglist`
TLouf Apr 10, 2023
bcba5f6
Handle bracket notation for optional params in HTML
TLouf Apr 10, 2023
3243f9d
Rename `on_single_line` to `on_separate_line`
TLouf Apr 10, 2023
93bdb8d
Fix latex for sigs starting with optional param
TLouf Apr 10, 2023
417db1f
Cleanup of HTML
TLouf Apr 11, 2023
c4e9c62
Update LaTeX to handle optional parameters in one line per param context
jfbu Apr 11, 2023
57004e3
Use some LaTeX hack to handle comma placement vs bracket
jfbu Apr 11, 2023
88cfe5a
Mark latex strings as raw to ignore backslashes
TLouf Apr 11, 2023
9ce3e34
Add trailing comma in expected HTML of tests
TLouf Apr 11, 2023
3379337
Merge branch 'master' into signature-linebreaks
jfbu Apr 11, 2023
98f1803
Move `and` operator to line start
TLouf Apr 16, 2023
ef7adde
Handle optionals in text writer
TLouf Apr 16, 2023
1ad0981
Add `single-line-parameter-list` as JS object option
TLouf Apr 16, 2023
e36c811
Add essential JS tests
TLouf Apr 16, 2023
ea30441
Actually test for `multi_line_parameter_list` bool
TLouf Apr 16, 2023
2d604b9
Add JS tests with `maximum_signature_line_length`
TLouf Apr 16, 2023
71f5a8a
Remove (probably) forgotten c test template
TLouf Apr 16, 2023
e948563
Make test names consistent
TLouf Apr 16, 2023
d2b3459
Add newline after dd tags to make more readable HTML
TLouf Apr 16, 2023
bfc353e
Test for optional syntax in js and py domains
TLouf Apr 16, 2023
0c54703
latex: handle comma placement in writer
TLouf Apr 16, 2023
a1b031f
latex: follow-up refactoring after TeX black magic removal
jfbu Apr 16, 2023
a0f5d9b
latex: tidy-up some comment in sphinxlatexstyletext.sty
jfbu Apr 16, 2023
a8a9be9
Fix comma placement when `required_params_left`
TLouf Apr 16, 2023
3b34e30
Fix case of multiple params at same optional level
TLouf Apr 16, 2023
2c1f83a
lint: remove extra line between method defs
TLouf Apr 16, 2023
9c625f1
Conform test to new syntax
TLouf Apr 16, 2023
5866fe6
Test for multiple params in optional level
TLouf Apr 17, 2023
3bef7e4
Make HTML asserts more modular to ease debugging
TLouf Apr 18, 2023
30041a6
Test xelatex PDF build
TLouf Apr 21, 2023
8037a5b
Actually override xelatex' build conf
TLouf Apr 21, 2023
2a85b9e
Merge branch 'master' into signature-linebreaks
jfbu Apr 21, 2023
35424ea
Document the added \sphinxparam, \sphinxparamcomma...
jfbu Apr 21, 2023
db91327
Add a specific latex unit test
jfbu Apr 21, 2023
1a44553
Remove blank line in latex.rst
jfbu Apr 21, 2023
0c4fdb8
Simplify parametrize of latex build test
TLouf Apr 22, 2023
36183f5
Add tests for text output
TLouf Apr 22, 2023
f2d1574
Bump versionadded in doc/latex.rst to match expected release number
jfbu Apr 24, 2023
370cd0e
Bump again versionadded in doc/latex.rst to match expected release
jfbu Apr 30, 2023
50ac9a6
Merge branch 'master' into signature-linebreaks
AA-Turner May 11, 2023
585b2b9
misc updates (inc version bump)
AA-Turner May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion doc/latex.rst
View file
Open in desktop
Expand Up @@ -1477,7 +1477,12 @@ Macros
``\sphinxkeyboard``

.. versionadded:: 6.2.0
``\sphinxparam``, ``\sphinxsamedocref``

jfbu marked this conversation as resolved.
Show resolved Hide resolved
``\sphinxparam``, ``\sphinxsamedocref``. There is also
``\sphinxparamcomma`` which defaults to a comma followed by a space and
``\sphinxparamcommaoneperline`` which is used for one-parameter-per-line
signatures (see :confval:`maximum_signature_line_length`). It defaults
to ``\texttt{,}`` to make these end-of-line separators more distinctive.

- More text styling:

Expand Down