Added .envrc and .gitignore to structure

whisk-ml · May 15, 2020 · 0047876 · 0047876
1 parent f84210d
commit 0047876
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# whisk documentation
+# whisk documentation home
 
 __whisk is an open-source ML project framework that makes collaboration, reproducibility, and deployment "just work".__ It combines a suite of lightweight tools with a logical and flexible project structure. Release your model to the world without a software engineer.
 
@@ -126,7 +126,7 @@ The [whisk-ml](https://github.com/whisk-ml) GitHub org contains example whisk pr
 ```eval_rst
 .. toctree::
    :maxdepth: 1
-   
+
    index
    key_concepts
    installation

diff --git a/docs/project_structure.md b/docs/project_structure.md
@@ -56,7 +56,12 @@ A project created with [`whisk create`](cli_reference.html#whisk-create) generat
     ├── venv                  <- The Python3 virtual environment for the project.
     │
     └── whisk_commands        <- Add custom `whisk` CLI commands and override existing ones.
-        │                        Powered by https://click.palletsprojects.com/en/7.x/.
-        └── app.py
+    │   │                        Powered by https://click.palletsprojects.com/en/7.x/.
+    │    └── app.py
+    │
+    ├── .envrc                <- A default file to auto load/unload environment variables and the venv when entering and
+    │                            exiting the directory via direnv. See https://github.com/direnv/direnv.
+    │                             
+    └── .gitignore            <- A .gitignore configured for whisk with sensible defaults
 
 This structure is inspired by [Cookiecutter Data Science](https://github.com/drivendata/cookiecutter-data-science) and [Cookiecutter PyPackage](https://github.com/audreyr/cookiecutter-pypackage).