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

merged 110 commits into from May 11, 2023

Commits on Jan 3, 2023

  1. ENH: enable multiline signatures when too long.

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    82f1b98 View commit details
    Browse the repository at this point in the history

  2. Make parameter nodes inherit from sig classes

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    8d6dfba View commit details
    Browse the repository at this point in the history

  3. Fix permalink for multiline Python signatures

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    581433b View commit details
    Browse the repository at this point in the history

  4. Enable multiline sig for C and C++

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    d3ec233 View commit details
    Browse the repository at this point in the history

  5. Simplify desc_parameterlist into single class

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    1229b66 View commit details
    Browse the repository at this point in the history

  6. Fix flake8 errors

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    ec713e9 View commit details
    Browse the repository at this point in the history

  7. Pass multiline as desc_parameterlist attribute

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    85ff493 View commit details
    Browse the repository at this point in the history

  8. Add type annotation

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    8ca560d View commit details
    Browse the repository at this point in the history

  9. Use new desc_parameterline instead of desc_content

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    9ec4698 View commit details
    Browse the repository at this point in the history

  10. Support HTML writer

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    b93ecf0 View commit details
    Browse the repository at this point in the history

  11. Support text writer

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    3b110ce View commit details
    Browse the repository at this point in the history

  12. Increment environment versions

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    234acd6 View commit details
    Browse the repository at this point in the history

  13. Better variable names

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    7c016c9 View commit details
    Browse the repository at this point in the history

  14. Expand docstrings of new nodes' classes

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    5b8735d View commit details
    Browse the repository at this point in the history

  15. Fix oversight of param line name change in C++

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    1ca68b0 View commit details
    Browse the repository at this point in the history

  16. Add newlines to make param list HTML prettier

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    8e198f3 View commit details
    Browse the repository at this point in the history

  17. Tweak EPUB's CSS to match HTML's

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    25ae353 View commit details
    Browse the repository at this point in the history

  18. Add tests for python domain

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    d6b2dac View commit details
    Browse the repository at this point in the history

  19. Add tests for C domain

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    af77cad View commit details
    Browse the repository at this point in the history

  20. Add tests for C++ domain

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    ea89180 View commit details
    Browse the repository at this point in the history

  21. Add minimal implementation for man and texinfo

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    5cc07d6 View commit details
    Browse the repository at this point in the history

  22. Python domain test cleanup

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    caff655 View commit details
    Browse the repository at this point in the history

  23. Make flake8 happy

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    b71b06d View commit details
    Browse the repository at this point in the history

  24. Make isort happy

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    88c2e09 View commit details
    Browse the repository at this point in the history

  25. Add doc

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    4258fd5 View commit details
    Browse the repository at this point in the history

  26. Make docslint happy

    @TLouf
    TLouf committed Jan 3, 2023
    Copy the full SHA
    6e6261c View commit details
    Browse the repository at this point in the history

Commits on Jan 8, 2023

  1. Add types for maximum_signature_line_length

    @TLouf
    TLouf committed Jan 8, 2023
    Copy the full SHA
    9c52eae View commit details
    Browse the repository at this point in the history

  2. Fix typo

    @TLouf
    TLouf committed Jan 8, 2023
    Copy the full SHA
    2d9ad80 View commit details
    Browse the repository at this point in the history

  3. Add global maximum_signature_line_length config

    @TLouf
    TLouf committed Jan 8, 2023
    Copy the full SHA
    0bc3b68 View commit details
    Browse the repository at this point in the history

Commits on Jan 20, 2023

  1. Add tentative LaTeX implementation

    @TLouf
    TLouf committed Jan 20, 2023
    Copy the full SHA
    2c0da6a View commit details
    Browse the repository at this point in the history

  2. Merge branch 'master' into signature-linebreaks

    @TLouf
    TLouf committed Jan 20, 2023
    Copy the full SHA
    bba2b51 View commit details
    Browse the repository at this point in the history

  3. Make docslint happy

    @TLouf
    TLouf committed Jan 20, 2023
    Copy the full SHA
    d8df099 View commit details
    Browse the repository at this point in the history

Commits on Jan 23, 2023

  1. Merge branch 'master' into signature-linebreaks

    @jfbu
    jfbu committed Jan 23, 2023
    Copy the full SHA
    d18f973 View commit details
    Browse the repository at this point in the history

  2. Cleanup latex style 

    Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
    @TLouf @jfbu
    TLouf and jfbu committed Jan 23, 2023
    Copy the full SHA
    d803e68 View commit details
    Browse the repository at this point in the history

  3. Rename new latex command for clarity

    @TLouf
    TLouf committed Jan 23, 2023
    Copy the full SHA
    3753e7e View commit details
    Browse the repository at this point in the history

  4. Force zero margins for dl tag

    @TLouf
    TLouf committed Jan 23, 2023
    Copy the full SHA
    eb63da6 View commit details
    Browse the repository at this point in the history

Commits on Jan 24, 2023

  1. latex: avoid page break above first function argument 

    Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
    @TLouf @jfbu
    TLouf and jfbu committed Jan 24, 2023
    Copy the full SHA
    53e882f View commit details
    Browse the repository at this point in the history

  2. latex: match coding style of LaTeX macro files in for loop 

    Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
    @TLouf @jfbu
    TLouf and jfbu committed Jan 24, 2023
    Copy the full SHA
    d7508a0 View commit details
    Browse the repository at this point in the history

  3. latex: rename command to pysigwithonelineperarg

    @TLouf
    TLouf committed Jan 24, 2023
    Copy the full SHA
    b665647 View commit details
    Browse the repository at this point in the history

  4. latex: avoid page break before dedented closing brace 

    Co-authored-by: Jean-François B. <2589111+jfbu@users.noreply.github.com>
    @TLouf @jfbu
    TLouf and jfbu committed Jan 24, 2023
    Copy the full SHA
    ada9d00 View commit details
    Browse the repository at this point in the history

  5. Update versionadded

    @TLouf
    TLouf committed Jan 24, 2023
    Copy the full SHA
    ed7fac8 View commit details
    Browse the repository at this point in the history

  6. docs: fix linking to single-line-signature

    @TLouf
    TLouf committed Jan 24, 2023
    Copy the full SHA
    1475f5f View commit details
    Browse the repository at this point in the history

Commits on Jan 25, 2023

  1. docs: better linking to single-line-signature

    @TLouf
    TLouf committed Jan 25, 2023
    Copy the full SHA
    9b9e694 View commit details
    Browse the repository at this point in the history

Commits on Apr 7, 2023

  1. Merge branch 'master' into signature-linebreaks

    @TLouf
    TLouf committed Apr 7, 2023
    Copy the full SHA
    691a780 View commit details
    Browse the repository at this point in the history

  2. Add trailing commas for ruff

    @TLouf
    TLouf committed Apr 7, 2023
    Copy the full SHA
    4deb58c View commit details
    Browse the repository at this point in the history

  3. Add trailing commas in tests

    @TLouf
    TLouf committed Apr 7, 2023
    Copy the full SHA
    48d2ccb View commit details
    Browse the repository at this point in the history

  4. Add desc_parameter_line to doc

    @TLouf
    TLouf committed Apr 7, 2023
    Copy the full SHA
    b065ab7 View commit details
    Browse the repository at this point in the history

  5. Merge branch 'master' into signature-linebreaks

    @AA-Turner
    AA-Turner committed Apr 7, 2023
    Copy the full SHA
    8d42ac1 View commit details
    Browse the repository at this point in the history

Commits on Apr 8, 2023

  1. Update config docs

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    2b864fe View commit details
    Browse the repository at this point in the history

  2. Update option docs

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    fa97a15 View commit details
    Browse the repository at this point in the history

  3. Move options to end

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    d787002 View commit details
    Browse the repository at this point in the history

  4. Revert changes to the frozen HTML 4 writer

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    707650f View commit details
    Browse the repository at this point in the history

  5. Revert is_multiline -> `is_multi_line rename for ``desc_signa… 

    …ture`` nodes

The attribute is used in e.g. Breathe, better not to change.
(though would be nice to)
    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    b1cb1b3 View commit details
    Browse the repository at this point in the history

  6. maximum_signature_line_length type to be int | None

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    8308742 View commit details
    Browse the repository at this point in the history

  7. Rename single-line-signature to ``single-line-{parameter,argument… 

    …}-list``
    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    e6ef3c2 View commit details
    Browse the repository at this point in the history

  8. Refactor tests 

    If something fails, it is now easier to pinpoint where
    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    dfd0075 View commit details
    Browse the repository at this point in the history

  9. Set and use multi_line_parameter_list on node

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    bfab7ea View commit details
    Browse the repository at this point in the history

  10. Remove desc_parameter_line

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    26551bc View commit details
    Browse the repository at this point in the history

  11. options docs typo (macro -> function)

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    9d03de0 View commit details
    Browse the repository at this point in the history

  12. CHANGES entry

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    b3e5662 View commit details
    Browse the repository at this point in the history

  13. fixup! Remove desc_parameter_line

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    592c86c View commit details
    Browse the repository at this point in the history

  14. Restore stripped whitespace

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    1af1a2e View commit details
    Browse the repository at this point in the history

  15. fixup! (round 2) Remove desc_parameter_line

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    69dba4b View commit details
    Browse the repository at this point in the history

  16. Remove unneeded py domain permalink logic

    @AA-Turner
    AA-Turner committed Apr 8, 2023
    Copy the full SHA
    2918995 View commit details
    Browse the repository at this point in the history

  17. Restore cross-reference to single line option

    @TLouf
    TLouf committed Apr 8, 2023
    Copy the full SHA
    d58b63c View commit details
    Browse the repository at this point in the history

  18. Add JS domain implentation 

    Include in the docs as well, tests still missing
    @TLouf
    TLouf committed Apr 8, 2023
    Copy the full SHA
    b866b88 View commit details
    Browse the repository at this point in the history

Commits on Apr 9, 2023

  1. Mention @jfbu in CHANGES

    @TLouf
    TLouf committed Apr 9, 2023
    Copy the full SHA
    c6cf460 View commit details
    Browse the repository at this point in the history

  2. Unify directive option to single-line-parameter-list

    @TLouf
    TLouf committed Apr 9, 2023
    Copy the full SHA
    b18c481 View commit details
    Browse the repository at this point in the history

  3. Fix directive hyperlink in CHANGES

    @TLouf
    TLouf committed Apr 9, 2023
    Copy the full SHA
    4b47e79 View commit details
    Browse the repository at this point in the history

Commits on Apr 10, 2023

  1. Pass multiline bool to _pseudo_parse_arglist

    @TLouf
    TLouf committed Apr 10, 2023
    Copy the full SHA
    a652d3e View commit details
    Browse the repository at this point in the history

  2. Handle bracket notation for optional params in HTML

    @TLouf
    TLouf committed Apr 10, 2023
    Copy the full SHA
    bcba5f6 View commit details
    Browse the repository at this point in the history

  3. Rename on_single_line to on_separate_line

    @TLouf
    TLouf committed Apr 10, 2023
    Copy the full SHA
    3243f9d View commit details
    Browse the repository at this point in the history

  4. Fix latex for sigs starting with optional param

    @TLouf
    TLouf committed Apr 10, 2023
    Copy the full SHA
    93bdb8d View commit details
    Browse the repository at this point in the history

Commits on Apr 11, 2023

  1. Cleanup of HTML

    @TLouf
    TLouf committed Apr 11, 2023
    Copy the full SHA
    417db1f View commit details
    Browse the repository at this point in the history

  2. Update LaTeX to handle optional parameters in one line per param context 

    The internal LaTeX code is based on a different logic than formerly:
now, it is the \sphinxparam which triggers a new line, not the commas.

Added some mark-up which will make possible customizing the style of the
commas.

Signatures with one line per parameter use currently a specific
\sphinxcode{,} which is customizable at user level.  Others use standard
commas, also customizable at user level.
    @jfbu
    jfbu committed Apr 11, 2023
    Copy the full SHA
    c4e9c62 View commit details
    Browse the repository at this point in the history

  3. Use some LaTeX hack to handle comma placement vs bracket 

    But this should probably be handled by sphinx.writers.latex to have
easier mark-up to work with at LaTeX level.
    @jfbu
    jfbu committed Apr 11, 2023
    Copy the full SHA
    57004e3 View commit details
    Browse the repository at this point in the history

  4. Mark latex strings as raw to ignore backslashes

    @TLouf
    TLouf committed Apr 11, 2023
    Copy the full SHA
    88cfe5a View commit details
    Browse the repository at this point in the history

  5. Add trailing comma in expected HTML of tests

    @TLouf
    TLouf committed Apr 11, 2023
    Copy the full SHA
    9ce3e34 View commit details
    Browse the repository at this point in the history

  6. Merge branch 'master' into signature-linebreaks

    @jfbu
    jfbu committed Apr 11, 2023
    Copy the full SHA
    3379337 View commit details
    Browse the repository at this point in the history

Commits on Apr 16, 2023

  1. Move and operator to line start

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    98f1803 View commit details
    Browse the repository at this point in the history

  2. Handle optionals in text writer

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    ef7adde View commit details
    Browse the repository at this point in the history

  3. Add single-line-parameter-list as JS object option

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    1ad0981 View commit details
    Browse the repository at this point in the history

  4. Add essential JS tests

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    e36c811 View commit details
    Browse the repository at this point in the history

  5. Actually test for multi_line_parameter_list bool

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    ea30441 View commit details
    Browse the repository at this point in the history

  6. Add JS tests with maximum_signature_line_length

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    2d604b9 View commit details
    Browse the repository at this point in the history

  7. Remove (probably) forgotten c test template

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    71f5a8a View commit details
    Browse the repository at this point in the history

  8. Make test names consistent

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    e948563 View commit details
    Browse the repository at this point in the history

  9. Add newline after dd tags to make more readable HTML

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    d2b3459 View commit details
    Browse the repository at this point in the history

  10. Test for optional syntax in js and py domains

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    bfc353e View commit details
    Browse the repository at this point in the history

  11. latex: handle comma placement in writer 

    Use smilar logic as in other writers, and remove TeX black magic.
    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    0c54703 View commit details
    Browse the repository at this point in the history

  12. latex: follow-up refactoring after TeX black magic removal

    @jfbu
    jfbu committed Apr 16, 2023
    Copy the full SHA
    a1b031f View commit details
    Browse the repository at this point in the history

  13. latex: tidy-up some comment in sphinxlatexstyletext.sty

    @jfbu
    jfbu committed Apr 16, 2023
    Copy the full SHA
    a0f5d9b View commit details
    Browse the repository at this point in the history

  14. Fix comma placement when required_params_left

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    a8a9be9 View commit details
    Browse the repository at this point in the history

  15. Fix case of multiple params at same optional level

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    3b34e30 View commit details
    Browse the repository at this point in the history

  16. lint: remove extra line between method defs

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    2c1f83a View commit details
    Browse the repository at this point in the history

  17. Conform test to new syntax

    @TLouf
    TLouf committed Apr 16, 2023
    Copy the full SHA
    9c625f1 View commit details
    Browse the repository at this point in the history

Commits on Apr 17, 2023

  1. Test for multiple params in optional level

    @TLouf
    TLouf committed Apr 17, 2023
    Copy the full SHA
    5866fe6 View commit details
    Browse the repository at this point in the history

Commits on Apr 18, 2023

  1. Make HTML asserts more modular to ease debugging

    @TLouf
    TLouf committed Apr 18, 2023
    Copy the full SHA
    3bef7e4 View commit details
    Browse the repository at this point in the history

Commits on Apr 21, 2023

  1. Test xelatex PDF build 

    Skip other engines to reduce testing time.
    @TLouf
    TLouf committed Apr 21, 2023
    Copy the full SHA
    30041a6 View commit details
    Browse the repository at this point in the history

  2. Actually override xelatex' build conf

    @TLouf
    TLouf committed Apr 21, 2023
    Copy the full SHA
    8037a5b View commit details
    Browse the repository at this point in the history

  3. Merge branch 'master' into signature-linebreaks

    @jfbu
    jfbu committed Apr 21, 2023
    Copy the full SHA
    2a85b9e View commit details
    Browse the repository at this point in the history

  4. Document the added \sphinxparam, \sphinxparamcomma...

    @jfbu
    jfbu committed Apr 21, 2023
    Copy the full SHA
    35424ea View commit details
    Browse the repository at this point in the history

  5. Add a specific latex unit test 

    I hesitated:

- whether to reuse as here a test source which was prepared for Python
  domain and used there already,

- in place of this, rather add a check of the sphinxtests.tex contents
  as output from the test_build_latex_doc for pdflatex engine.
    @jfbu
    jfbu committed Apr 21, 2023
    Copy the full SHA
    db91327 View commit details
    Browse the repository at this point in the history

  6. Remove blank line in latex.rst

    @jfbu
    jfbu committed Apr 21, 2023
    Copy the full SHA
    1a44553 View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2023

  1. Simplify parametrize of latex build test

    @TLouf
    TLouf committed Apr 22, 2023
    Copy the full SHA
    0c4fdb8 View commit details
    Browse the repository at this point in the history

  2. Add tests for text output

    @TLouf
    TLouf committed Apr 22, 2023
    Copy the full SHA
    36183f5 View commit details
    Browse the repository at this point in the history

Commits on Apr 24, 2023

  1. Bump versionadded in doc/latex.rst to match expected release number

    @jfbu
    jfbu committed Apr 24, 2023
    Copy the full SHA
    f2d1574 View commit details
    Browse the repository at this point in the history

Commits on Apr 30, 2023

  1. Bump again versionadded in doc/latex.rst to match expected release

    @jfbu
    jfbu committed Apr 30, 2023
    Copy the full SHA
    370cd0e View commit details
    Browse the repository at this point in the history

Commits on May 11, 2023

  1. Merge branch 'master' into signature-linebreaks 

    # Conflicts:
#	CHANGES
    @AA-Turner
    AA-Turner committed May 11, 2023
    Copy the full SHA
    50ac9a6 View commit details
    Browse the repository at this point in the history

  2. misc updates (inc version bump)

    @AA-Turner
    AA-Turner committed May 11, 2023
    Copy the full SHA
    585b2b9 View commit details
    Browse the repository at this point in the history