Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanx749/auto-sphinx-page-action
GitHub action that creates website using Sphinx.
https://github.com/yuanx749/auto-sphinx-page-action
github-actions markdown tool
Last synced: 10 days ago
JSON representation
GitHub action that creates website using Sphinx.
- Host: GitHub
- URL: https://github.com/yuanx749/auto-sphinx-page-action
- Owner: yuanx749
- License: mit
- Created: 2023-03-14T05:35:16.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-10T04:45:14.000Z (11 months ago)
- Last Synced: 2025-01-27T21:57:45.158Z (15 days ago)
- Topics: github-actions, markdown, tool
- Language: Python
- Homepage: https://github.com/marketplace/actions/auto-sphinx-page
- Size: 10.7 KB
- Stars: 6
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# auto-sphinx-page-action
GitHub action that creates website using Sphinx.
This action creates a website from your repository, by building with Sphinx.
## Features
- Set up the configuration of Sphinx automatically.
- Use `README` as the homepage if `index` does not exist at the root level.
- Use [PyData](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html) theme.
- Support MyST Markdown. For more information, see [MyST-Parser](http://myst-parser.readthedocs.io/).
- Publish to GitHub Pages.
- Can customize with `conf.py`.
## Usage
Refer to the GitHub [docs](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) to enable publishing to GitHub Pages.
Set up a workflow in Actions. An example `.yml` file is as below.
```YAML
on:
workflow_dispatch:
push:
branches:
- main
- master
jobs:
build-deploy:
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- id: deployment
uses: yuanx749/auto-sphinx-page-action@main
with:
project: "project" # project's name, optional, default repository name
author: "author" # author name, optional, default username
```
Or use a reusable workflow:
```YAML
on:
workflow_dispatch:
push:
jobs:
build-deploy:
permissions:
pages: write
id-token: write
uses: yuanx749/auto-sphinx-page-action/.github/workflows/main.yml@main
```
For repository with customized docs folder:
```YAML
on:
workflow_dispatch:
push:
branches:
- main
jobs:
build-deploy:
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- id: deployment
uses: yuanx749/auto-sphinx-page-action@main
with:
sourcedir: "docs" # source directory, optional, default .
requirements: "docs/requirements.txt" # path to the requirements file, optional
```