-
Notifications
You must be signed in to change notification settings - Fork 796
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
Refractoring the documentation #1992
Comments
Thanks for your interest! A .d file is like any other autoduck file, but instead of being embedded in c++ source files it's a stand-alone file. Autoduck is somewhat like a pre-processor - it parses the source files and .d files, and generates a HTMLHelp project, which ends up creating html in a .chm file - the html can be extracted out from that, which is how https://mhammond.github.io/pywin32/ exists. We don't have the source-code to autoduck. With that in mind:
I'm not sure what you mean here - migrate what exactly? Most docs which aren't processed by autoduck already are HTML.
What would that mean to all the existing autoduck markup? |
Sorry for the extremely late reply.
I was unaware Autoduck would parse the C++ files for additional docs. This would cross out option 1.
Potentially, doxygen can be used. If configured with macros, we can make it interpret things like |
Adding to this conversation: Type annotations live in https://github.com/python/typeshed/tree/main/stubs/pywin32 In the (very) long term, it'd be great if type stubs for C-extension modules could be generated first party. So far everything I've seen (numpy, OpenCV, PySide/Qt) all use custom solutions based on their documentation + extra custom processing steps. Relates to #1535 |
There's a lot of very interesting discussion in swig/swig#735 |
Currently the documentation is scattered, and I feel that it would be much easier to work on the documentation if it was restructured. For example, the is_api overview documentation is at is_api/doc and is written in HTML, while the python com and win32 docs are in /com/help and win32/help respectively and are written in a combination of HTML and "d", which seems to be related to autoduck in some way, and the adodbapi directory does not seem to have a documentation directory at all. I would suggest that one of the following options is perused:
The text was updated successfully, but these errors were encountered: