400Ping opened a new issue, #1012: URL: https://github.com/apache/mahout/issues/1012
### Summary Implement an automated API documentation pipeline that generates and publishes API reference documentation from the Python (Qumat, QDP) and Rust (qdp-core) codebases, integrated into the project's Docusaurus website and CI. Current state: - QuMat API is maintained by hand and can drift from code. - QDP API has a placeholder "TODO: Add API reference documentation for QDP". - Rust (qdp-core) has extensive doc comments but no published rustdoc in the website. Goals: 1. Generate API reference from source for Python (Qumat + QDP) and Rust (qdp-core). 2. Integrate generated docs into the existing Docusaurus site. 3. Automate the pipeline in CI so doc builds run on changes. 4. Define conventions (docstrings, public API) for future contributors. Deliverables: - Python API doc pipeline (Sphinx or pdoc) for qumat and QDP. - QDP API reference page populated (replace TODO). - QuMat API reference either generated or explicitly linked. - Rust (qdp-core) rustdoc built and linked from the website. - CI job(s) that build Python API docs and rustdoc and fail on errors. - Short contribution guide on docstring style and how to update API docs. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
