asyml / asyml/texar

Documentation improvement

Open
#215 0 comments 0 reactions 0 assignees View on GitHub
enhancement topic: docs
Dominant language
Python
Stars
2.4k
Forks
367
PR merge metrics
No merged PRs in 30d

Description

1. Add CI test for building documentations (Do not ignore `warnings` and add spellcheck).
2. Fix docstrings with incorrect/inconsistent Sphinx format. Currently, such issues are treated as `warnings` in the docs building.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing documentation build configuration and CI workflow, then identify how warnings are currently handled and where spellchecking can be added. Review the Python docstrings that produce Sphinx warnings and bring their formats into consistency; done means the documentation build passes without ignored warnings and includes spellcheck validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.