pan-os-python
pan-os-python copied to clipboard
PaloAltoNetworks
Documentation is broken
Documentation rending broken!
Seems to be a rendering issue
https://pan-os-python.readthedocs.io/en/latest/module-firewall.html
Workaround is to select the 'stable' version (instead of 'Latest'). Bottom right corner.
Now the stable version is also not rendering for me. Does anyone else have similar issues? Any work around?
Same here… The stable branch was the workaound, and now it’s gone too.
From: Hanyang-Luo @.> Sent: Wednesday, April 24, 2024 7:10 PM To: PaloAltoNetworks/pan-os-python @.> Cc: Subscribed @.***> Subject: Re: [PaloAltoNetworks/pan-os-python] Documentation is broken (Issue #542)
Now the stable version is also not rendering for me. Does anyone else have similar issues? Any work around? — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you are subscribed to this thread. Message
Now the stable version is also not rendering for me. Does anyone else have similar issues? Any work around?
— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https:/github.com/PaloAltoNetworks/pan-os-python/issues/542*issuecomment-2075544735__;Iw!!HWWtag!wwI0aDqJntl1FobVa2_lBi4sNozyuuzqjxgLgbZ9mVD9YL0yAjKXShNTXaAuRexDxtcbkO-5YnmKBnDQ2Z8no-iR4rGd$, or unsubscribehttps://urldefense.com/v3/__https:/github.com/notifications/unsubscribe-auth/AYBODG6KXTKQCITWQWBHYD3Y67YQPAVCNFSM6AAAAABCAICTW6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANZVGU2DINZTGU__;!!HWWtag!wwI0aDqJntl1FobVa2_lBi4sNozyuuzqjxgLgbZ9mVD9YL0yAjKXShNTXaAuRexDxtcbkO-5YnmKBnDQ2Z8noyT5i22J$. You are receiving this because you are subscribed to this thread.Message ID: @.@.>>
=============================================================================== Please refer to http://www.kkr.com/email-disclaimer for important disclosures regarding this electronic communication. KKR uses your personal information in accordance with its privacy notices, which can be found on http://www.kkr.com.
The work around I found right now is to look into the source code. I am guessing how readTheDocs render the doc is by extracting the text string in each method. For example, I want to lookup the function "refresh_devices()" under panorama object. I can find the specification of input and output in the funciton header.
It is annoying that we can't find all the method documentation in one place but this is better than nothing.
Hi everyone, apologies for the current issue with the docs. Just to let you know that the team are aware of the issue and will be progressing a fix as soon as possible
@btorresgil It still seems to not be fully working. It shows the relational diagrams, but missing the actual description of each object.
I am experiencing the same issue. The detail documentation of object, methods, and class were not accessible.