You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: