ahmad88me/Sphinx Docs
Automates Sphinx docs generation: builds structure, extracts metadata, creates HTML, cleans up, and preps for GitHub Pages.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| python-version | Version of Python to set up | no | 3.8 |
| git-username | Git username for commits | no | yourusername |
| git-email | Git email for commits | no | youremail@users.noreply.github.com |
| project-path | Path to the Sphinx project | no | src |
| files-pattern | Pattern to match example files | no | — |
| commit-message | Commit message for the documentation update | no | update docs |
| github-token | GitHub token to push changes. | yes | — |
| readme | The path to the readme fiel to be included in the docs index | no | — |
| args | Add extra arguments to the sphinx example includer | no | — |
Outputs
| name | description |
|---|---|
| docs-path | Path to the generated documentation |