https://github.com/peaceiris/test-sphinx
https://github.com/peaceiris/test-sphinx
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/peaceiris/test-sphinx
- Owner: peaceiris
- Created: 2021-06-16T01:48:33.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-17T14:20:17.000Z (about 5 years ago)
- Last Synced: 2024-10-06T05:21:56.896Z (almost 2 years ago)
- Language: Python
- Homepage: https://peaceiris.github.io/test-sphinx/
- Size: 189 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## test-sphinx
An example to deploy [sphinx](https://www.sphinx-doc.org/) website to GitHub Pages with [the GitHub Pages Action](https://github.com/peaceiris/actions-gh-pages).
### Clone and Build
```sh
git clone https://github.com/peaceiris/test-sphinx.git
cd test-sphinx
pipenv sync --dev
pipenv run make html
```
The project was generated as follows.
```
pipenv install --dev sphinx
pipenv run sphinx-quickstart
```
### Custom Domain
`CNAME` file will be generated by the [html_baseurl](https://github.com/peaceiris/test-sphinx/blob/48a9a3bf9888f61ace5adc369e3e87a860a06ef2/source/conf.py#L25).
cf. [sphinx.ext.githubpages – Publish HTML docs in GitHub Pages — Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html#module-sphinx.ext.githubpages)