Skip to content

Updating docs for 0.1.1 release #16

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,15 @@ jobs:

- name: Copy static vignettes over to docs directory
run: |
cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
cp vignettes/R/IV/iv.html docs/vignettes/R/iv.html

- name: Build the overall doc site
run: |
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,15 @@ cp stochtree_repo/demo/notebooks/prototype_interface.ipynb docs/python_docs/demo
### Copy static vignettes over to docs directory

```{bash}
cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
cp vignettes/R/IV/iv.html docs/vignettes/R/iv.html
```

### Building the overall website
Expand Down
15 changes: 9 additions & 6 deletions dev/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,15 @@ cp stochtree_repo/demo/notebooks/tree_inspection.ipynb docs/python_docs/demo/tre
cp stochtree_repo/demo/notebooks/prototype_interface.ipynb docs/python_docs/demo/prototype_interface.ipynb

# Copy static vignettes over to docs directory
cp vignettes/Python/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/RDD/rdd.html docs/vignettes/Python/rdd.html
cp vignettes/Python/RDD/RDD_DAG.png docs/vignettes/Python/RDD_DAG.png
cp vignettes/Python/RDD/trees1.png docs/vignettes/Python/trees1.png
cp vignettes/Python/RDD/trees2.png docs/vignettes/Python/trees2.png
cp vignettes/Python/RDD/trees3.png docs/vignettes/Python/trees3.png
cp vignettes/R/RDD/rdd.html docs/vignettes/R/rdd.html
cp vignettes/Python/IV/iv.html docs/vignettes/Python/iv.html
cp vignettes/Python/IV/IV_CDAG.png docs/vignettes/Python/IV_CDAG.png
cp vignettes/R/IV/iv.html docs/vignettes/R/iv.html

# Build the doc site
mkdocs build
1 change: 1 addition & 0 deletions docs/vignettes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ with an R and Python version for each vignette.
Current advanced vignettes include:

1. Using `stochtree` for Regression Discontinuity Design ([R](R/rdd.html), [Python](Python/rdd.html))
2. Using `stochtree` for Instrumental Variables Analysis ([R](R/iv.html), [Python](Python/iv.html))
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,11 @@ nav:
- 'Vignettes':
- 'Vignettes': vignettes/index.md
- 'R':
- 'RDD': 'vignettes/R/rdd.html'
- 'Instrumental Variables': 'vignettes/R/IV/iv.html'
- 'RDD': 'vignettes/R/RDD/rdd.html'
- 'Python':
- 'RDD': 'vignettes/Python/rdd.html'
- 'Instrumental Variables': 'vignettes/Python/IV/iv.html'
- 'RDD': 'vignettes/Python/RDD/rdd.html'
- 'Development':
- 'Development': development/index.md
- 'Contributing': development/contributing.md
Expand Down
Binary file added vignettes/Python/IV/IV_CDAG.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading