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

autodoc: Add :no-value: option to autoattribute and autodata to suppress the default value of the variable #8424

Merged
merged 6 commits into from
Nov 18, 2020
Merged

autodoc: Add :no-value: option to autoattribute and autodata to suppress the default value of the variable #8424

merged 6 commits into from
Nov 18, 2020

Commits on Nov 15, 2020

  1. autodoc: add :novalue: option 

    When the :annotation: option is not used, the :novalue: option may be used to remove the value.
This is useful when you want to display the type hint but not the value, and you don't want to specify the annotation manually.
    @marlonjames @tk0miya
    marlonjames authored and tk0miya committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    04b374a View commit details
    Browse the repository at this point in the history

  2. autodoc: document :novalue: option

    @marlonjames @tk0miya
    marlonjames authored and tk0miya committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    6082ce6 View commit details
    Browse the repository at this point in the history

  3. Rename :novalue: option to :no-value: option 

    According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
    @tk0miya
    tk0miya committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    5676fde View commit details
    Browse the repository at this point in the history

  4. Update CHANGES for PR sphinx-doc#8222

    @tk0miya
    tk0miya committed Nov 15, 2020
    Configuration menu
    Copy the full SHA
    a4ccca7 View commit details
    Browse the repository at this point in the history

Commits on Nov 17, 2020

  1. autodoc: Fix :no-value: option for autoattribute does not work

    @tk0miya
    tk0miya committed Nov 17, 2020
    Configuration menu
    Copy the full SHA
    f203a15 View commit details
    Browse the repository at this point in the history

  2. Merge branch '3.x' into 8222_novalue

    @tk0miya
    tk0miya committed Nov 17, 2020
    Configuration menu
    Copy the full SHA
    3becd56 View commit details
    Browse the repository at this point in the history