Closed AJQuinn closed 1 year ago
It would also be great to include more information on the docs page - some of this is duplicated in the README file but should be consistent across github and readthedocs if both are maintained. Currently a user landing on readthedocs could get a bit lost...
Can you look into adding/fixing:
Hi @AJQuinn , I believe I have fixed all these issues in the documentation. Please reopen the issue if you feel that these haven't been fixed. I am working on the usage examples for the other issue.
Hello - one weakness in this (otherwise excellent) repo is the readthedocs pages here: https://spectral-connectivity.readthedocs.io/en/latest/ - these seem rushed and a bit of an afterthought.
One concern is that the build generates a really large number of warnings and exceptions listed in the final tab here https://readthedocs.org/projects/spectral-connectivity/builds/18509808/
some examples
Perhaps not a major issue on its own but suggests that the build is fairly fragile and likely missing some details. Could you take a look and fix up some of these issues?
I've tried to make a local build to say something more productive but keep running into a docutils error.
xref: https://github.com/openjournals/joss-reviews/issues/4840