initial docs

wsp-sag · Jan 17, 2022 · 4b3ada5 · 4b3ada5
1 parent 37f2d4f
commit 4b3ada5
Show file tree

Hide file tree

Showing 9 changed files with 1,034 additions and 7 deletions.
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,28 @@
+# Book settings
+# Learn more at https://jupyterbook.org/customize/config.html
+
+title: sharrow documentation
+author: Cambridge Systematics, Inc.
+logo: logo.png
+
+# Force re-execution of notebooks on each build.
+# See https://jupyterbook.org/content/execute.html
+execute:
+  execute_notebooks: force
+
+# Define the name of the latex output file for PDF builds
+latex:
+  latex_documents:
+    targetname: book.tex
+
+# Information about where the book exists on the web
+repository:
+  url: https://github.com/camsys/sharrow  # Online location of your book
+  path_to_book: docs  # Optional path to your book, relative to the repository root
+  branch: master  # Which branch of the repository should be used when creating links (optional)
+
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  use_issues_button: true
+  use_repository_button: true
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -0,0 +1,7 @@
+# Table of contents
+# Learn more at https://jupyterbook.org/customize/toc.html
+
+format: jb-book
+root: intro
+chapters:
+- file: walkthrough
diff --git a/docs/intro.md b/docs/intro.md
@@ -0,0 +1,4 @@
+# Sharrow Documentation
+
+Sharrow is a library that enables compiling expression specification
+files into optimized, runnable code.
diff --git a/docs/logo.png b/docs/logo.png
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,9 @@
+jupyter-book
+matplotlib
+numpy >= 1.19
+pandas >= 1.2
+pyarrow >= 3.0.0
+xarray >= 0.20.0
+numba >= 0.53
+numexpr
+filelock