Skip to content

Move docs from readthedocs to github.io #20

Description

@tmcclintock

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions