ioos / ioos-python-package-skeleton Goto Github PK

• add some of the code sprint presentation content to the README to explain its purpose better;
• create a github.io page/docs built with sphinx with the contents, that will demonstrate the documentation auto-build and keep the contentes in a readable form.

• How to create a simple python package with just one module (or CLI) with flit
• How to package an existing project with a bare minimum

https://github.com/ioos/ioos-python-package-skeleton/blob/main/CONTRIBUTING.md

We should update this to be more specific about how folks should be interacting with these doc sites.

from @dpsnowden:

do I work on main or gh-pages? and Do I commit directly if I'm working on a site with other people or do I fork/pr?

I see two cases:

1. Those who have admin privs. (don't need to fork)
2. Those who don't. (need to fork)

We can build off https://github.com/ioos/ioos_code_lab/blob/main/CONTRIBUTING.md#building-new-notebooks