Add 'make publish' target

This commit is contained in:
Jordan Cook 2022-11-14 22:04:04 -06:00
parent f38a524412
commit 113a908241
4 changed files with 14 additions and 9 deletions

View File

@ -6,9 +6,12 @@ clean:
docs:
sphinx-build pages _build/html
livedocs:
livedocs: clean
sphinx-autobuild pages _build/html -a \
--watch assets \
--watch pages/conf.py \
--ignore '*.tmp' \
--port 8181
publish:
rsync -a _build/html/* tilde:~/public_html/

View File

@ -1,6 +1,7 @@
# jwcook's tilde.team page
Markdown-based static site generated with Sphinx and MyST
Markdown-based static site generated with [Sphinx](docs.readthedocs.io) and [MyST](https://myst-parser.readthedocs.io).
## Usage
Prerequisites:
* python 3.8+
@ -10,7 +11,12 @@ pip install -U -r requirements.txt
make docs
```
Or with live reload:
Or build with live reload:
```bash
make livedocs
```
Publish to tilde.team:
```bash
make publish
```

View File

@ -1,7 +1,3 @@
from os.path import join
from pathlib import Path
from shutil import copy
# General information about the project.
project = 'jwcook'
needs_sphinx = '4.0'
@ -46,7 +42,7 @@ html_css_files = [
'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css',
]
html_js_files = []
html_title = "jwcook's home page"
html_title = '~jwcook'
# html_logo = '../assets/logo.png'
html_show_copyright = False
html_show_sphinx = False

View File

@ -1,4 +1,4 @@
# jwcook's home page
# ~jwcook
## Contents
```{toctree}