Skip to content

Commit e1b0924

Browse files
neuralsorcerermeta-codesync[bot]
authored andcommitted
Include poststratify tutorial in docs build (#143)
Summary: Made sure the docs build script creates the tutorials HTML output directory and generates HTML for the poststratify quickstart notebook so the tutorial page is published correctly. Also cleaned up title formatting. Pull Request resolved: #143 Reviewed By: omriharosh Differential Revision: D86887871 Pulled By: talgalili fbshipit-source-id: 6e6458c9fdf1679840c99aca8ff45d297990aecf
1 parent 995c8bb commit e1b0924

File tree

6 files changed

+15
-7
lines changed

6 files changed

+15
-7
lines changed

scripts/make_docs.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,13 @@ if [[ $ONLY_DOCUSAURUS == false ]]; then
7777
echo "-----------------------------------"
7878
echo "Building tutorial HTML"
7979
echo "-----------------------------------"
80+
mkdir -p website/static/html/tutorials
8081
jupyter nbconvert tutorials/balance_quickstart.ipynb --execute --to html \
8182
--output-dir website/static/html/tutorials
8283
jupyter nbconvert tutorials/balance_quickstart_cbps.ipynb --execute --to html \
8384
--output-dir website/static/html/tutorials
85+
jupyter nbconvert tutorials/balance_quickstart_poststratify.ipynb --execute --to html \
86+
--output-dir website/static/html/tutorials
8487
jupyter nbconvert tutorials/balance_quickstart_rake.ipynb --execute --to html \
8588
--output-dir website/static/html/tutorials
8689
jupyter nbconvert tutorials/balance_transformations_and_formulas.ipynb --execute --to html \

website/docs/tutorials/balance_transformations_and_formulas.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: balance_transformations_and_formulas
3-
sidebar_position: 5
2+
title: Balance Transformations and Formulas
3+
sidebar_position: 6
44
hide_table_of_contents: true
55
hide_title: true
6+
sidebar_label: Transformations and Formulas
67
---
78

89
import HTMLLoader from '@site/src/components/HTMLLoader';

website/docs/tutorials/comparing_cbps_in_r_vs_python_using_sim_data.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Comparing_cbps_in_r_vs_python_using_sim_data
3-
sidebar_position: 6
2+
title: Comparing CBPS in R vs Python Using Simulated Data
3+
sidebar_position: 7
44
hide_table_of_contents: true
55
hide_title: true
6+
sidebar_label: Comparing CBPS in R vs Python
67
---
78

89
import HTMLLoader from '@site/src/components/HTMLLoader';

website/docs/tutorials/quickstart_cbps.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Quickstart_cbps
2+
title: Quickstart CBPS
33
sidebar_position: 3
44
hide_table_of_contents: true
55
hide_title: true
6+
sidebar_label: Quickstart (CBPS)
67
---
78

89
import HTMLLoader from '@site/src/components/HTMLLoader';

website/docs/tutorials/quickstart_poststratify.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Quickstart_poststratify
2+
title: Quickstart Poststratify
33
sidebar_position: 5
44
hide_table_of_contents: true
55
hide_title: true
6+
sidebar_label: Quickstart (Poststratify)
67
---
78

89
import HTMLLoader from '@site/src/components/HTMLLoader';

website/docs/tutorials/quickstart_rake.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
2-
title: Quickstart_rake
2+
title: Quickstart Rake
33
sidebar_position: 4
44
hide_table_of_contents: true
55
hide_title: true
6+
sidebar_label: Quickstart (Rake)
67
---
78

89
import HTMLLoader from '@site/src/components/HTMLLoader';

0 commit comments

Comments
 (0)