Skip to content

Commit f3ac55d

Browse files
committed
Add some text to reference index page
1 parent 7887d8c commit f3ac55d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/gen_ref_pages.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,4 +51,8 @@
5151
# > So basically, you can use the literate-nav plugin just for its ability to
5252
# > infer only sub-directories, without ever writing any actual "literate navs".
5353
with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
54-
nav_file.writelines(nav.build_literate_nav())
54+
# nav_file.writelines(nav.build_literate_nav())
55+
nav_file.writelines(
56+
"# Code reference\nUse links in sidebar to navigate the code docstrings.\n"
57+
+ "".join(list(nav.build_literate_nav()))
58+
)

0 commit comments

Comments
 (0)