Skip to content

Commit 5bd9c0c

Browse files
authored
Merge pull request #1257 from luarss/fix_docs_toc
[Docs] Fix Toc
2 parents 0f70f74 + 4c15adb commit 5bd9c0c

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,6 @@
5959

6060
# The suffix(es) of source filenames.
6161
# You can specify multiple suffix as a list of string:
62-
#
63-
# source_suffix = ['.rst', '.md']
6462
source_suffix = ['.md']
6563

6664
# The master toctree document.
@@ -94,6 +92,10 @@
9492
html_theme_options = {
9593
"repository_url": "https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts",
9694
"repository_branch": "master",
95+
"show_navbar_depth": 2,
96+
"use_edit_page_button": True,
97+
"use_source_button": True,
98+
"use_issues_button": True,
9799
"use_download_button": True,
98100

99101
# list for more fine-grained ordering of icons

docs/toc.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
root: index
22
entries:
33

4-
- file: /dev/null
5-
title: ORFS Documentation
4+
- file: user/UserGuide.md
5+
title: User Guide
66
entries:
77
- file: user/BuildWithDocker
88
title: Build With Docker
@@ -13,8 +13,8 @@ entries:
1313
title: Build With Pre-built Binaries
1414
- file: user/BuildLocally.md
1515
title: Build Locally
16-
- file: user/UserGuide.md
17-
title: User Guide
16+
- file: user/BuildWithWSL.md
17+
title: Build With WSL
1818
- file: user/FlowVariables.md
1919
title: Flow Variables
2020
- file: contrib/Metrics.md

0 commit comments

Comments
 (0)