-
Notifications
You must be signed in to change notification settings - Fork 22
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
Docsite #199
Docsite #199
Conversation
Codecov Report
@@ Coverage Diff @@
## main #199 +/- ##
=======================================
Coverage 82.43% 82.43%
=======================================
Files 28 28
Lines 1560 1560
=======================================
Hits 1286 1286
Misses 274 274
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to commit all of the generated files?
Right now we're publishing the docs using GitHub pages on a branch, which requires the files to be in the repo. GitHub also offers another alternate workflow that, I believe, does not require the files to be checked in, but since this is just a temporary solution, I went for the simplest one. If we decide to keep GitHub Pages as the hosting solution, I think it's worth exploring. |
Co-authored-by: pablo-gar <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Adds a docsite for cell-census, using Sphinx.
Notes:
doc
folder and the artifacts are indocs
. For GitHub Pages, there needs to be anindex.html
indocs
so that folder is best reserved for it. Maybe renamingdoc
todocs-sphinx
could be a good idea.