Skip to content

Commit

Permalink
Do not execute notebooks when generating doc. (#91)
Browse files Browse the repository at this point in the history
* Do not execute notebooks when generating doc.

* Add Github link to notebook file inside each notebook file.
  • Loading branch information
notoraptor authored Nov 28, 2023
1 parent dd18cbd commit df6d8cd
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,6 @@

html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

# nbsphinx config
nbsphinx_execute = "never"
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
"source": [
"# Notebook 1\n",
"\n",
"You can get the notebook file [here](https://github.com/mila-iqia/SARC/blob/master/docs/notebooks/notebook_1_sarc_connection_and_users_list.ipynb).\n",
"\n",
"## Connect to SARC virtual machine\n",
"\n",
"For this example, and more generally for any use of SARC, you need to access SARC virtual machine in normal (read-only) mode, with config file `config/sarc-client.json`.\n",
Expand Down
2 changes: 2 additions & 0 deletions docs/notebooks/notebook_2_jobs_from_users_list.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
"source": [
"# Notebook 2 - Get jobs from a users list\n",
"\n",
"You can get the notebook file [here](https://github.com/mila-iqia/SARC/blob/master/docs/notebooks/notebook_2_jobs_from_users_list.ipynb).\n",
"\n",
"In this example, you will learn how to get jobs from a users list.\n",
"\n",
"Let's first configure the `SARC_CONFIG` variable, as in notebook 1:"
Expand Down
2 changes: 2 additions & 0 deletions docs/notebooks/notebook_3_usage_stats.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
"source": [
"# Notebook 3 - Get usage stats for a specific period\n",
"\n",
"You can get the notebook file [here](https://github.com/mila-iqia/SARC/blob/master/docs/notebooks/notebook_3_usage_stats.ipynb).\n",
"\n",
"This example provides a code to compute usage statistics for a specific period on a list of clusters.\n",
"\n",
"(based on examples/usage_stats.py)\n",
Expand Down

0 comments on commit df6d8cd

Please sign in to comment.