ghpages

ghpages is a CLI tool for easily publishing static content to GitHub Pages.

For example, it is useful to publish API documentation generated by Sphinx

Install

via: pipx (Recommended)

pipx install ghpages

via: pip

pip install ghpages

via: rye (Recommended)

rye install ghpages

Usage

Publish the contents of the dist directory

ghpages dist

Congratulations! If you see a success message, you are ready to publish on GitHub Pages!

Development

setup

poetry install

activate

poetry shell

setup pre-commit

poetry run pre-commit install

run tox

poetry run tox