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.

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

add members to automodule for Sphinx to pickup docstrings #576

Merged

Conversation

DctrG
Copy link
Contributor

@DctrG DctrG commented Sep 25, 2024

Description

Added ":members:" to module-*.rst files.

Motivation and Context

The current documentation is missing the docstrings from the classes in the modules, it shows only the docstring from the module itself which is not useful for the module users.

How Has This Been Tested?

I run "make docs" for Sphinx to crate the docs and verified that the docstrings are now populated.

Screenshots (if appropriate)

This is what the current documentation shows:
class-reference-current

This is what it will show with the changes:
class-reference-change

Types of changes

  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@da110us
Copy link

da110us commented Oct 1, 2024

Finally! Thank you!!

Copy link
Member

@jamesholland-uk jamesholland-uk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like @DctrG tested the changes locally, and the changes only touch the documentation which is already broken so the risk in this change is low, with the goal of fixing this part of the docs.

@jamesholland-uk jamesholland-uk merged commit e0add15 into PaloAltoNetworks:develop Oct 14, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants