Deployment Guide¶

This website is designed to be deployed automatically to GitHub Pages from the main branch.

Repository¶

Recommended web repository:

https://github.com/p2ms-optimization/pysne-web

After pushing this project to GitHub, open:

Settings > Pages > Build and deployment > Source

Then choose:

GitHub Actions

The workflow file is located here:

.github/workflows/static.yml

Every commit pushed to the main branch will run:

pip install -r requirements.txt
mkdocs build --strict

Then it uploads the generated site/ folder and publishes it to GitHub Pages.

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Open:

http://127.0.0.1:8000

If PySNE later uses a custom domain, for example:

pysne.org

add a file named CNAME inside the docs/ folder containing only the domain name:

pysne.org

Then update site_url in mkdocs.yml.