search

DCMLab / wavescapes

Code and documentation for wavescapes
GNU General Public License v3.0
1 stars 0 forks source link

Discuss documentation deployment #4

Open cedricviaccoz opened 4 years ago

cedricviaccoz commented 4 years ago

Currently the documentation is generated using sphynx, with the rtd (readthedocs) renderer. The documentation lies directly in the code of the library as multiline comments, and sphynx reads those comments in order to build documentation pages of the library.

For the first release, only 7 to 8 functions from the library will be provided to users (all other functions are helpers of those beforementionned one in order to reach better modularity and readability, so there is no point giving access to them for now). A discussion needs to be done on whether an actual documentation produced as webpages would make sense for this library, and if so, where and how to host it.

fabianmoss commented 4 years ago

Hosting on readthedocs works best with sphynx and is free. If we decide that a "proper" documentation is necessary beyond what's given in the code and the notebook, we should use this option imho.