PolicyEngine / policyengine.py

[WIP] PolicyEngine's main user-facing Python package, incorporating country packages and integrating data visualization and analytics.
GNU Affero General Public License v3.0
2 stars 4 forks source link

Add starter documentation #4

Closed nikhilwoodruff closed 2 weeks ago

nikhilwoodruff commented 1 month ago

Add a basic JupyterBook documentation site, published on GitHub pages that demonstrates basic usage of the (scaffold) class structure.

nikhilwoodruff commented 1 month ago

Should also use the PolicyEngine theme (see e.g. policyengine/policyengine-core for details)

nikhilwoodruff commented 2 weeks ago

We should ensure that the documentation is built and deployed to Github pages (plus a test of the docs build in PRs)

nikhilwoodruff commented 2 weeks ago

https://github.com/PolicyEngine/policyengine-uk/blob/master/.github/workflows/push.yml for an example