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

documentation not found #2

Open
qy-zh opened this issue Nov 1, 2023 · 1 comment
Open

documentation not found #2

qy-zh opened this issue Nov 1, 2023 · 1 comment

Comments

@qy-zh
Copy link

qy-zh commented Nov 1, 2023

I'm currently attempting to access the documentation for the 'wellknown-securitytxt' library by following the command provided in the README file:

pydoc wellknown-securitytxt

However, I received the following result:

No Python documentation found for 'wellknown-securitytxt'.

I would like to know how to properly access the documentation for this library. Your assistance would be greatly appreciated.

Thank you.

@stefan6419846
Copy link

While the package is named wellknown-securitytxt, the actual module is named securitytxt, thus you should use pydoc securitytxt instead. This basically parses the docstrings, thus you can just browse the source as well.

Besides the short introduction inside the README, there is no further "real" documentation apart from the docstrings itself.

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

No branches or pull requests

2 participants