cluster_toolkit icon indicating copy to clipboard operation
cluster_toolkit copied to clipboard

Move docs from readthedocs to github.io

Open tmcclintock opened this issue 6 years ago • 0 comments

The docs are currently hosted on readthedocs here. However, this is non-ideal because one needs to do some magic in a conf.py file to do magic imports of the toolkit before reading the docstrings. A better solution is to take advantage of the fact that github hosts docs now.

We can now host the docs on clutser_toolkit.githhub.io (or something like that) and provide pre-compiled documentation. We can compile the docs locally and then upload them, without having to deal with any RTD problems.

I will also take this chance to move away from autodocs, which have been a little finicky.

tmcclintock avatar Jul 25 '19 15:07 tmcclintock