documentation

[gregstarr]

perhaps sphinx

[josephsamela]

Before worrying about docs, first I'd suggest building pychop3d into a proper package. Once you can install as a package, then you can use pydoc to generate your documentation. It comes built-in with copy of python. You use it like this...

python -m pydoc <name of installed package>

It will create documentation for any installed package. For example, try running...

$ python -m pydoc requests

With this approach, the documentation is the docstrings. You get clean-code and neat documentation all in one easy motion! ✨

[josephsamela]

Regarding documentation hosting...let's use Github pages!

As part of the package build process pydoc can generate documentation as markdown in the /docs folder. Github will automatically turn any .md files there into webpages and host them*.

For example, I'm hosting the readme on my fork with the "cayman" theme.
https://josephsamela.github.io/pychop3d/

*it will only host what's in master. I merged develop -> master in my fork and it merged cleanly.

[gregstarr]

Awesome! That looks great. I have many of the functions documented using reStructured Text which I know can be turned into docs and static web pages using sphinx