Restructure the project to use src/particleman instead of particleman to hold packages. This helps with testing (pytest test will use the installed version of particleman instead of simply importing a top-level particleman package directory), and it frees up the top-level docs directory for hosting the html documentation in GitHub Pages.
This also adds a "github" directive in the Sphinx Makefile, which copies the _build/html directory contents into docs.
Restructure the project to use
src/particleman
instead ofparticleman
to hold packages. This helps with testing (pytest test
will use the installed version of particleman instead of simply importing a top-levelparticleman
package directory), and it frees up the top-leveldocs
directory for hosting the html documentation in GitHub Pages.This also adds a "github" directive in the Sphinx
Makefile
, which copies the_build/html
directory contents intodocs
.