How do you generate your documentation for the cpp lib? #19430
-
|
I would like to try a few things to make the API docs located here https://codeql.github.com/codeql-standard-libraries/cpp/index.html more usable but I am not seeing what you are using to generate this. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 1 reply
-
|
Hi Unfortunately, the code that is used to generate the docs is proprietary. I believe we have long wanted to give it an overhaul, but I'm not sure what the status is on that (cc @adityasharad). |
Beta Was this translation helpful? Give feedback.
-
|
That's right. The functionality is available through an internal-facing CodeQL CLI command |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the quick reply! I'd really appreciate it if we could get some sort of hierarchical view of the modules. It would be super helpful to easily compare the APIs for things like The way the Python standard library is documented at https://docs.python.org/3/library/index.html is what I have in mind as a gold standard. Not only are the modules organized hierarchically, but they're also grouped by function (like Data Types and Data Persistence). So, the first thing I considered doing with the doc generation code was adding a view that would allow for hierarchical navigation based on the module location, something like this: This would be a great improvement of QoL for me when creating queries! Thanks again! |
Beta Was this translation helpful? Give feedback.
That's right. The functionality is available through an internal-facing CodeQL CLI command
codeql generate library-doc, which you're welcome to try on your own, however changing it involves our proprietary code. We'd be happy to hear your requests and suggestions here or in issues on this repo instead, and we'll consider them as we improve the docs themselves.