You are viewing a plain text version of this content. The canonical link for it is here.
Posted to gsoc@community.apache.org by "Jie-Kai Chang (Jira)" <ji...@apache.org> on 2026/02/03 14:15:00 UTC
[jira] [Updated] (GSOC-313) Apache Mahout: Automated API Documentation Pipeline for Qumat & QDP
[ https://issues.apache.org/jira/browse/GSOC-313?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jie-Kai Chang updated GSOC-313:
-------------------------------
Labels: Mahout gsoc2026 mahout mentor part-time (was: Mahout gsoc2026 mahout part-time)
> Apache Mahout: Automated API Documentation Pipeline for Qumat & QDP
> -------------------------------------------------------------------
>
> Key: GSOC-313
> URL: https://issues.apache.org/jira/browse/GSOC-313
> Project: Comdev GSOC
> Issue Type: New Feature
> Reporter: Jie-Kai Chang
> Priority: Major
> Labels: Mahout, gsoc2026, mahout, mentor, part-time
> Original Estimate: 2.5h
> Remaining Estimate: 2.5h
>
> *Backgroud*
> 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.
> *Tracked github issue*
> [https://github.com/apache/mahout/issues/1012]
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: gsoc-unsubscribe@community.apache.org
For additional commands, e-mail: gsoc-help@community.apache.org