Skip to content

Commit 28a11a0

Browse files
committed
Fix typo in root folder reference, update name of notebook index template and add options to argparse parameter help.
1 parent 73289fd commit 28a11a0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

website/create_index.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,12 @@ def parse_args():
111111
parser.add_argument(
112112
"index_type", choices=["html", "notebook"],
113113
metavar="INDEX_TYPE",
114-
help="Whether to generate an HTML or Markdown Jupyter notebook index.",
114+
help="Whether to generate an HTML or Markdown Jupyter notebook index [html, notebook].",
115115
)
116116
parser.add_argument(
117117
"qutip_version", choices=["v4", "v5"],
118118
metavar="QUTIP_VERSION",
119-
help="Which QuTiP version to generate the tutorial index for.",
119+
help="Which QuTiP version to generate the tutorial index for [v4, v5].",
120120
)
121121
parser.add_argument(
122122
"output_file",
@@ -133,7 +133,7 @@ def main():
133133

134134
if args.qutip_version == "v4":
135135
title = "Tutorials for QuTiP Version 4"
136-
tutorials_folder = root_foloder / "tutorials-v4"
136+
tutorials_folder = root_folder / "tutorials-v4"
137137
version_note = """
138138
These are the tutorials for QuTiP Version 4. You can
139139
find the tutorials for QuTiP Version 5
@@ -161,7 +161,7 @@ def main():
161161
tutorials=tutorials,
162162
)
163163
elif args.index_type == "notebook":
164-
template = root_folder / "website" / "index.md.jinja"
164+
template = root_folder / "website" / "index.notebook.jinja"
165165
text = render_template(
166166
template,
167167
title=title,

0 commit comments

Comments
 (0)