asyml / asyml/forte

Add Sphinx Build and Sphinx Spelling Check to pre-commit hook

Open
#737 0 comments 0 reactions 0 assignees View on GitHub
topic: docs
Dominant language
Python
Stars
253
Forks
59
PR merge metrics
No merged PRs in 30d

Description

According to https://github.com/KhronosGroup/SYCL_Reference/blob/main/.pre-commit-config.yaml, there is a way to add customized sphinx build and sphinx spelling into pre-commit hook which can automating checks locally.

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

Contributor guide

Open the contributing guide

Research direction

Start by comparing the referenced SYCL_Reference .pre-commit-config.yaml with Forte's existing pre-commit configuration and documentation setup. Determine how Sphinx build and spelling checks can run locally, then verify that both checks execute successfully through the pre-commit hook.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.