-
Notifications
You must be signed in to change notification settings - Fork 73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Nuke the sphinx docs? #350
Comments
Having gained admin access I took another look at our GitHub deployments and did some cleaning up and polishing for #366 — for the Sphinx docs in particular I made them only deploy when a new tag is pushed to I also looked at how Since we can make these doc deployments less messy and more useful, and Sphinx actually does a good job of segregating the document data ( |
Using sphinx to auto-generate help pages for docstrings in the commands/API seems helpful, but I do think gitbook is much easier for writing tutorials/user guides. Should we have both? |
Yup, just to clarify:
is a recommendation for what we should try! I will be working on cleaning up the gitbook content and will also continue trying to produce something more useful from the Sphin |
We moved our documentation to gitbook (preference for a WYSIWYG editor): https://ez-lab.gitbook.io/cryodrgn/
@michal-g was going to look into possibly revisiting sphinx docs, but pending that, we should remove the sphinx docs (
docs
) from the repo and turn off the automatic deployment/ delete thegh-pages
branch.The text was updated successfully, but these errors were encountered: