-
Notifications
You must be signed in to change notification settings - Fork 60
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
Make Kernel API docs easily accessible #89
Comments
Building the docs for the current Linux kernels with sphinx-5.1.1 does not work:
Related: sphinx-doc/sphinx#8313 |
For the most basic ones we could just scrape |
Apparently, the requirements listed in
After fixing that, building the docs is still not straightforward (for this version):
Related: readthedocs/readthedocs.org#9038 Bottom-line: Always building the docs for the kernel version specified Maybe always building the docs for the latest kernel version (as shown here: https://www.kernel.org/doc/html/latest/) could help us. Alternatively, learning how to scrape the online sphinx documentation to allow a use-case like the following would be nice too:
The above should return an easily digestible format (e.g.: rendered HTML) like the following to the CLI: This would eradicate the need to use a browser for searching... |
Sometimes you just want to quickly look up basic kernel APIs.
Sadly,
man(9)
is not always available.So, it would be nice to have a convenient way to look up kernel API functions from the terminal.
The text was updated successfully, but these errors were encountered: