Skip to content

Document internal module-level constants #2096

Open
@echedey-ls

Description

@echedey-ls

Is your feature request related to a problem? Please describe.
A lot of times constants are referenced in the documentation, but the only way to access them is either by visual inspection of the code or importing the object that contains it programmatically.

Describe the solution you'd like
Include constants in a toctree and add their respective documentation.

Describe alternatives you've considered
A toctree dedicated exclusively to all pvlib constants.

Additional context
https://stackoverflow.com/questions/40748886/how-can-i-document-a-constant-module-level-variable-with-sphinx-docstring-wit
https://stackoverflow.com/questions/50831070/how-to-document-linkable-constants-with-sphinx

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions