Skip to content

Commit 96dd589

Browse files
authored
Merge pull request #1918 from luarss/manpage_docs
[Docs] add manpage docs
2 parents 3e9593f + b9f478c commit 96dd589

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ perf.data.old
8888
docs/main
8989
docs/build
9090
GitGuide.md
91+
Manpage.md
9192
mainREADME.md
9293
build
9394
.scala-build/

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ def setup(app):
151151
shutil.copy('../README.md', 'mainREADME.md')
152152
swap_prefix('mainREADME.md', '```mermaid', '```{mermaid}\n:align: center\n')
153153

154+
# Get GitGuide file
154155
url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/contrib/GitGuide.md'
155156
get_file_from_url(url, 'contrib/GitGuide.md')
156157

@@ -163,3 +164,7 @@ def setup(app):
163164
content = content.replace('The-OpenROAD-flow-scripts', 'The-OpenROAD')
164165
with open('contrib/GitGuide.md', 'w') as f:
165166
f.write(content)
167+
168+
# Get Manpage file
169+
url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/src/utl/README.md'
170+
get_file_from_url(url, 'Manpage.md')

docs/toc.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ entries:
2222
- file: user/InstructionsForAutoTuner.md
2323
title: AutoTuner
2424

25+
- file: Manpage.md
26+
title: Manpages
27+
2528
- file: contrib/GettingInvolved.md
2629
title: Getting Involved
2730

@@ -51,4 +54,4 @@ entries:
5154
- file: user/QoRDashboard.md
5255
title: Using the OpenROAD Dashboard to track and analyze QoR
5356
- file: user/Jenkins.md
54-
title: Exploring CI Metrics with Jenkins
57+
title: Exploring CI Metrics with Jenkins

0 commit comments

Comments
 (0)