Skip to content

Commit

Permalink
Jacques/doc updates (#821)
Browse files Browse the repository at this point in the history
* Removed cookbooks in md format

* Removed autogenerated files and updated build scripts

* Updated gitignore file for autogenerated files

* Update build script

* Updated build script
  • Loading branch information
jverre authored Dec 5, 2024
1 parent 1244826 commit 6d1c366
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion apps/opik-documentation/documentation/build_script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ npm run docusaurus clean-api-docs all
npm run docusaurus gen-api-docs all

# Rebuild the Cookbooks
jupyter nbconvert docs/cookbook/*.ipynb --clear-output --to markdown
jupyter nbconvert --clear-output --inplace docs/cookbook/*.ipynb
jupyter nbconvert docs/cookbook/*.ipynb --to markdown

# Build the docs
docusaurus build
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -88,7 +88,7 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -117,7 +117,7 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down
2 changes: 1 addition & 1 deletion apps/opik-documentation/documentation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"docusaurus": "docusaurus",
"start": "docusaurus start",
"dev": "sh dev_script.sh",
"build": "jupyter nbconvert docs/cookbook/*.ipynb --clear-output --to markdown && docusaurus build",
"build": "sh build_script.sh",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
Expand Down

0 comments on commit 6d1c366

Please sign in to comment.