dssg / dssg/triage

Implement Triage API reference to supplement current docs

Open
#778 4 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Jupyter Notebook
Stars
201
Forks
62
PR merge metrics
No merged PRs in 30d

Description

The Triage docs currently have limited information on the Triage API. And while Triage is fairly-well covered by class- and function-level docstrings, it is inconvenient to access this documentation inside the source code.

Limited access to information about the Triage API poses challenges for development, debugging, and other low-level use cases.

Implementing an automated API reference documentation system like [Sphinx](https://www.sphinx-doc.org/en/master/) would allow us to leverage existing source code documentation, creating a basic API reference site without too much pain.

Additionally, since Sphinx supports documents in the markdown format of our current docs, we could eventually integrate those with the new API reference docs.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current Triage documentation and the existing class- and function-level docstrings. Evaluate how Sphinx can generate an API reference and support the current Markdown documents, then define the smallest workable documentation setup. Done means a basic, accessible API reference site is generated from the existing source documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.