sphinx-notes / sphinx-notes/pages
It would be awesome if you could add a spot for apidoc calls
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- Shell
- Stars
- 100
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
An option before the push that would allow us to enter a popular apidoc call for example "sphinx-apidoc -f -o . .." With this we could completely automate sphinx docs on push.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the GitHub Actions workflow or entry point that runs before publishing Sphinx HTML output. Trace how push-time options are configured, then determine how an apidoc command such as sphinx-apidoc -f -o . .. would be accepted and executed. Done means the command can be configured and Sphinx documentation is automated on push.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, shell
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100