The PAN-OS SDK for Python is a package to help interact with Palo Alto Networks devices (including physical and virtualized Next-generation Firewalls and Panorama). The pan-os-python SDK is object oriented and mimics the traditional interaction with the device via the GUI or CLI/API.
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:
This is what it will show with the changes:
Types of changes
Bug fix (non-breaking change which fixes an issue)
Checklist
[ ] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes if appropriate.
da110us
commented
1 month ago
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:
This is what it will show with the changes:
Types of changes
Checklist