Skip to content
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

Merged
merged 15 commits into from
Feb 22, 2023
Merged

Docsite #199

merged 15 commits into from
Feb 22, 2023

Conversation

ebezzi
Copy link
Member

@ebezzi ebezzi commented Feb 17, 2023

Adds a docsite for cell-census, using Sphinx.

Notes:

  1. Right now, the Sphinx conf and sources are in the doc folder and the artifacts are in docs. For GitHub Pages, there needs to be an index.html in docs so that folder is best reserved for it. Maybe renaming doc to docs-sphinx could be a good idea.
  2. I will add a script that can be used to regenerate the docs. This should be automatic, but I wouldn't put too much effort until we finalize the hosting.

@codecov
Copy link

codecov bot commented Feb 17, 2023

Codecov Report

Merging #199 (5ea001e) into main (902d4a8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #199   +/-   ##
=======================================
  Coverage   82.43%   82.43%           
=======================================
  Files          28       28           
  Lines        1560     1560           
=======================================
  Hits         1286     1286           
  Misses        274      274           
Flag Coverage Δ
unittests 82.43% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
.../python/cell_census/src/cell_census/_experiment.py 90.00% <ø> (ø)
...python/cell_census/src/cell_census/_get_anndata.py 100.00% <ø> (ø)
api/python/cell_census/src/cell_census/_open.py 81.63% <ø> (ø)
...on/cell_census/src/cell_census/_presence_matrix.py 100.00% <ø> (ø)
.../cell_census/src/cell_census/_release_directory.py 89.65% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Collaborator

@Bento007 Bento007 left a 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?

doc/python-api.rst Outdated Show resolved Hide resolved
@ebezzi
Copy link
Member Author

ebezzi commented Feb 21, 2023

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.

@ebezzi ebezzi temporarily deployed to github-pages February 21, 2023 16:33 — with GitHub Pages Inactive
@ebezzi ebezzi temporarily deployed to github-pages February 21, 2023 16:50 — with GitHub Pages Inactive
@ebezzi ebezzi temporarily deployed to github-pages February 22, 2023 15:19 — with GitHub Pages Inactive
@ebezzi ebezzi temporarily deployed to github-pages February 22, 2023 16:52 — with GitHub Pages Inactive
@ebezzi ebezzi self-assigned this Feb 22, 2023
Copy link
Contributor

@pablo-gar pablo-gar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ebezzi ebezzi temporarily deployed to github-pages February 22, 2023 17:28 — with GitHub Pages Inactive
@ebezzi ebezzi temporarily deployed to github-pages February 22, 2023 18:53 — with GitHub Pages Inactive
@ebezzi ebezzi temporarily deployed to github-pages February 22, 2023 18:54 — with GitHub Pages Inactive
@ebezzi ebezzi merged commit 2e6a569 into main Feb 22, 2023
@ebezzi ebezzi deleted the ebezzi/docsite branch February 22, 2023 19:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants