Wiki examples for better documentation about nlmpy HOT 4 OPEN

This is definitely worth doing, and should provide guidance on how to choose parameters such as h in the midpoint displacement algorithm.

from nlmpy.

GitHub Pages seems to have advanced to a point where a dedicated website may be more helpful and intuitive.

from nlmpy.

I've had some fun with pdoc for documentation, see https://dosull.github.io/weaving-space/doc/weavingspace/index.html and the project page is https://pdoc3.github.io/pdoc/

If you link in some notebooks with usage guides from the documentation page headers, then I think you get a good blend of low level detail and higher level explanation

from nlmpy.

Another option is the kind of website you can make easily with quarto, which can be hosted on pages. See e.g., dosull.github.io/computing-geographically -- that site is mainly R, but quarto handles python notebooks equally well and has templates for blogs, books, etc.

from nlmpy.