From bc5907430089b68a4d6edfd37d32516f4f029446 Mon Sep 17 00:00:00 2001 From: Justin Kiggins Date: Thu, 20 Dec 2018 14:28:05 -0800 Subject: [PATCH] new docs (#525) * new docs * moves development docs to dev_docs --- .gitignore | 4 ++ {docs => dev_docs}/REST_API.md | 0 .../Release_Validation_Recipe.md | 0 {docs => dev_docs}/pull_request_guidelines.md | 0 {docs => dev_docs}/release_process.md | 0 docs/Gemfile | 2 + docs/_config.yml | 9 +++- docs/_layouts/default.html | 49 +++++++++++++++++++ docs/index.md | 8 +-- 9 files changed, 68 insertions(+), 4 deletions(-) rename {docs => dev_docs}/REST_API.md (100%) rename {docs => dev_docs}/Release_Validation_Recipe.md (100%) rename {docs => dev_docs}/pull_request_guidelines.md (100%) rename {docs => dev_docs}/release_process.md (100%) create mode 100644 docs/Gemfile create mode 100644 docs/_layouts/default.html diff --git a/.gitignore b/.gitignore index c0040151..32204627 100644 --- a/.gitignore +++ b/.gitignore @@ -35,3 +35,7 @@ npm-debug.log __pycache__ *.DS_Store* data + +# Jekyll +docs/_site/ +docs/Gemfile.lock diff --git a/docs/REST_API.md b/dev_docs/REST_API.md similarity index 100% rename from docs/REST_API.md rename to dev_docs/REST_API.md diff --git a/docs/Release_Validation_Recipe.md b/dev_docs/Release_Validation_Recipe.md similarity index 100% rename from docs/Release_Validation_Recipe.md rename to dev_docs/Release_Validation_Recipe.md diff --git a/docs/pull_request_guidelines.md b/dev_docs/pull_request_guidelines.md similarity index 100% rename from docs/pull_request_guidelines.md rename to dev_docs/pull_request_guidelines.md diff --git a/docs/release_process.md b/dev_docs/release_process.md similarity index 100% rename from docs/release_process.md rename to dev_docs/release_process.md diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 00000000..e44e449c --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,2 @@ +source 'https://rubygems.org' +gem "github-pages", group: :jekyll_plugins diff --git a/docs/_config.yml b/docs/_config.yml index 2f7efbea..5d25e6fc 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,8 @@ -theme: jekyll-theme-minimal \ No newline at end of file +theme: jekyll-theme-cayman +show_downloads: false + +nav: + - title: Data + url: data.html + - title: FAQ + url: faq.html diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html new file mode 100644 index 00000000..81ae146a --- /dev/null +++ b/docs/_layouts/default.html @@ -0,0 +1,49 @@ + + + + + {% if site.google_analytics %} + + + {% endif %} + + +{% seo %} + + + + + + + + + + +
+ {{ content }} + + +
+ + diff --git a/docs/index.md b/docs/index.md index 9069cda8..76827d48 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -_cellxgene_ is an interactive data explorer for single-cell transcriptomics data designed to handle large datasets (1 million cells or more) and integrate with your favorite analysis tools +_cellxgene_ is an interactive data explorer for single-cell transcriptomics data. Whether you need to visualize one thousand cells or one million, _cellxgene_ helps you gain insight into your single-cell data. ## features @@ -8,12 +8,14 @@ _cellxgene_ is an interactive data explorer for single-cell transcriptomics data ## getting started -Install the package +_cellxgene_ requires **Python 3.6** + +Install the package. ``` bash pip install cellxgene ``` -Download an example file +Download an example [anndata](https://anndata.readthedocs.io/en/latest/) file ``` bash curl -o pbmc3k.h5ad https://raw.githubusercontent.com/chanzuckerberg/cellxgene/master/example-dataset/pbmc3k.h5ad