README.md

Python Class

This repo is for the lessons and code related to the Python class that I've been teaching to a few friends and family.

» 📖 Go to the lessons »         

Development Notes

• Poetry: dependency management

command	description
poetry install --no-root	install dependencies
poetry shell	start virtual env shell

Docs

• Jupyter Book: document formatting and generation

  note: current release is at 8.3 but manually pulled at f32176e to get support for local_extensions config variable

• The Sphinx Book Theme: theme

Build

Generated Static HTML files with jupyter-book.

jupyter-book build docs

Deploy

• GitHub Pages: hosting of gh-pages branch
• peaceiris/actions-gh-pages via Github Actions: automatic deploy on push to master

(more info)

Production requirements are exported from the pyproject.toml using poetry as configured in the github action.

Github Config

• Pages:
  • Branch: gh-pages
  • Folder: / (root)
• Secrets & Deploy Key ACTIONS_PAGES_DEPLOY_KEY