-
Notifications
You must be signed in to change notification settings - Fork 37
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
Docs on website are behind docs in source code #21
Comments
I propose we start using automatic doc building through travis-ci. There is a library that is meant to deal with it: |
I solved this with what I think is a more elegant and definitive solution than what we had before. I setup the repo to have continuous integration through TravisCI and I use it to built the docs automatically upon any new commit. Importantly I also added ad edit button all the pages of the docs, allowing easy editing and correction. The deployment will gets served as a website. Unfortunately right now the url is http://linnarssonlab.org/loompy/ but it would be nice to redirect it to loompy.org/loompy . @slinnarsson can you redirect that url in some way? I guess not right? We are bound to the limit one organization one github-pages url, isn't it? Anyway let me know how you prefer to have it setup, I can always do something more hacky/indirect like this but I would like to avoid. The possibilities with TravisCI don't end here. Right now we have a job structure with one build and two deployments (see the
I recommend for the future we use Travis for further interesting automations:
(Just for future reference for conda package upload: since we have the |
I updated the docs and thanks to @gioelelm work setting up Travis CI, the docs flowed into the web site just fine! |
For example, the API walkthrough page still mentions
GeneName
as an attribute, but in the source of the documentation this has already been corrected toGene
.This actually indirectly led to an issue with the loom-viewer (although it does not seem to be the core problem)
EDIT: I guess you're the only person with the proper set-up to generate the docs right now, Gioelle?
The text was updated successfully, but these errors were encountered: