Add some documentation
Closed this issue · 9 comments
Please? :D
I think it's way too early to write any documentation (not all blocks are implemented, and their implementation is subject to change depending on what I consider handier). But as soon as I'm able to demodulate stuff with this library I will write down some details on the API. There are better libraries to do what I do here, though.
Any updates? Do you want some [guided] help?
I think it would be great to start documenting sigutils using something like https://readthedocs.org/
I have read a little bit on how to do this.
ReadTheDocs seems to rely on sphinx to generate the documentation. The first step towards this would be to setup sphinx.
Some tasks that may help towars that:
- Creating a module to locate Sphinx
- Creating a CMakeFileList.txt in the doc folder that locates sphinx and setups a doc target if found.
See:
https://www.sphinx-doc.org/en/master/usage/quickstart.html
https://github.com/k0ekk0ek/cmake-sphinx/tree/master
There is a WIP implementation of this. I cannot assing myself to the issue but I am working on it. There will be a PR soon :)
Initial doxygen deployment now available at https://batchdrake.github.io/sigutils/.
Documentation coverage reports are available and first steps towards documenting are being done in #66.
I understand that this is far away from a well rounded documentation but the mechanisms to document are in place. Should this issue be considered closed?
The initial documentation infrastructure is in place. Could this be considered done?
Assuming done due to inactivity.