Skip to content

Commit e3bb6bf

Browse files
acomodiacomodi
authored
Merge pull request #1785 from acomodi/fix-docs-links
docs: fix wrong markdown links
2 parents 35f0068 + d0fd038 commit e3bb6bf

File tree

6 files changed

+220
-10
lines changed

6 files changed

+220
-10
lines changed

‎.github/kokoro/continuous/nightly.cfg renamed to ‎.github/kokoro/continuous/nightly_test1.cfg

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ action {
2424
regex: "**/place.log.gz"
2525
regex: "**/route.log.gz"
2626
regex: "**/*_qor.csv.gz"
27-
2827
strip_prefix: "github/vtr-verilog-to-routing/"
2928
}
3029
}
@@ -52,7 +51,7 @@ env_vars {
5251

5352
env_vars {
5453
key: "VTR_TEST"
55-
value: "vtr_reg_nightly"
54+
value: "vtr_reg_nightly_test1"
5655
}
5756

5857
#Options for run_reg_test.py
@@ -64,5 +63,5 @@ env_vars {
6463

6564
env_vars {
6665
key: "NUM_CORES"
67-
value: "3"
66+
value: "8"
6867
}

‎.github/kokoro/continuous/nightly_test2.cfg

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Format: //devtools/kokoro/config/proto/build.proto
2+
3+
build_file: "vtr-verilog-to-routing/.github/kokoro/run-vtr.sh"
4+
5+
# 72 hours
6+
timeout_mins: 4320
7+
8+
action {
9+
define_artifacts {
10+
# File types
11+
regex: "**/*.out"
12+
regex: "**/vpr_stdout.log"
13+
regex: "**/parse_results.txt"
14+
regex: "**/qor_results.txt"
15+
regex: "**/pack.log"
16+
regex: "**/place.log"
17+
regex: "**/route.log"
18+
regex: "**/*_qor.csv"
19+
regex: "**/*.out.gz"
20+
regex: "**/vpr_stdout.log.gz"
21+
regex: "**/parse_results.txt.gz"
22+
regex: "**/qor_results.txt.gz"
23+
regex: "**/pack.log.gz"
24+
regex: "**/place.log.gz"
25+
regex: "**/route.log.gz"
26+
regex: "**/*_qor.csv.gz"
27+
strip_prefix: "github/vtr-verilog-to-routing/"
28+
}
29+
}
30+
31+
env_vars {
32+
key: "KOKORO_TYPE"
33+
value: "continuous"
34+
}
35+
36+
env_vars {
37+
key: "KOKORO_DIR"
38+
value: "vtr-verilog-to-routing"
39+
}
40+
41+
env_vars {
42+
key: "VTR_DIR"
43+
value: "vtr-verilog-to-routing"
44+
}
45+
46+
#Use default build configuration
47+
env_vars {
48+
key: "VTR_CMAKE_PARAMS"
49+
value: ""
50+
}
51+
52+
env_vars {
53+
key: "VTR_TEST"
54+
value: "vtr_reg_nightly_test2"
55+
}
56+
57+
#Options for run_reg_test.py
58+
# -show_failures: show tool failures in main log output
59+
env_vars {
60+
key: "VTR_TEST_OPTIONS"
61+
value: "-show_failures"
62+
}
63+
64+
env_vars {
65+
key: "NUM_CORES"
66+
value: "8"
67+
}

‎.github/kokoro/continuous/nightly_test3.cfg

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Format: //devtools/kokoro/config/proto/build.proto
2+
3+
build_file: "vtr-verilog-to-routing/.github/kokoro/run-vtr.sh"
4+
5+
# 72 hours
6+
timeout_mins: 4320
7+
8+
action {
9+
define_artifacts {
10+
# File types
11+
regex: "**/*.out"
12+
regex: "**/vpr_stdout.log"
13+
regex: "**/parse_results.txt"
14+
regex: "**/qor_results.txt"
15+
regex: "**/pack.log"
16+
regex: "**/place.log"
17+
regex: "**/route.log"
18+
regex: "**/*_qor.csv"
19+
regex: "**/*.out.gz"
20+
regex: "**/vpr_stdout.log.gz"
21+
regex: "**/parse_results.txt.gz"
22+
regex: "**/qor_results.txt.gz"
23+
regex: "**/pack.log.gz"
24+
regex: "**/place.log.gz"
25+
regex: "**/route.log.gz"
26+
regex: "**/*_qor.csv.gz"
27+
strip_prefix: "github/vtr-verilog-to-routing/"
28+
}
29+
}
30+
31+
env_vars {
32+
key: "KOKORO_TYPE"
33+
value: "continuous"
34+
}
35+
36+
env_vars {
37+
key: "KOKORO_DIR"
38+
value: "vtr-verilog-to-routing"
39+
}
40+
41+
env_vars {
42+
key: "VTR_DIR"
43+
value: "vtr-verilog-to-routing"
44+
}
45+
46+
#Use default build configuration
47+
env_vars {
48+
key: "VTR_CMAKE_PARAMS"
49+
value: ""
50+
}
51+
52+
env_vars {
53+
key: "VTR_TEST"
54+
value: "vtr_reg_nightly_test3"
55+
}
56+
57+
#Options for run_reg_test.py
58+
# -show_failures: show tool failures in main log output
59+
env_vars {
60+
key: "VTR_TEST_OPTIONS"
61+
value: "-show_failures"
62+
}
63+
64+
env_vars {
65+
key: "NUM_CORES"
66+
value: "8"
67+
}

‎.github/kokoro/continuous/nightly_test4.cfg

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Format: //devtools/kokoro/config/proto/build.proto
2+
3+
build_file: "vtr-verilog-to-routing/.github/kokoro/run-vtr.sh"
4+
5+
# 72 hours
6+
timeout_mins: 4320
7+
8+
action {
9+
define_artifacts {
10+
# File types
11+
regex: "**/*.out"
12+
regex: "**/vpr_stdout.log"
13+
regex: "**/parse_results.txt"
14+
regex: "**/qor_results.txt"
15+
regex: "**/pack.log"
16+
regex: "**/place.log"
17+
regex: "**/route.log"
18+
regex: "**/*_qor.csv"
19+
regex: "**/*.out.gz"
20+
regex: "**/vpr_stdout.log.gz"
21+
regex: "**/parse_results.txt.gz"
22+
regex: "**/qor_results.txt.gz"
23+
regex: "**/pack.log.gz"
24+
regex: "**/place.log.gz"
25+
regex: "**/route.log.gz"
26+
regex: "**/*_qor.csv.gz"
27+
strip_prefix: "github/vtr-verilog-to-routing/"
28+
}
29+
}
30+
31+
env_vars {
32+
key: "KOKORO_TYPE"
33+
value: "continuous"
34+
}
35+
36+
env_vars {
37+
key: "KOKORO_DIR"
38+
value: "vtr-verilog-to-routing"
39+
}
40+
41+
env_vars {
42+
key: "VTR_DIR"
43+
value: "vtr-verilog-to-routing"
44+
}
45+
46+
#Use default build configuration
47+
env_vars {
48+
key: "VTR_CMAKE_PARAMS"
49+
value: ""
50+
}
51+
52+
env_vars {
53+
key: "VTR_TEST"
54+
value: "vtr_reg_nightly_test4"
55+
}
56+
57+
#Options for run_reg_test.py
58+
# -show_failures: show tool failures in main log output
59+
env_vars {
60+
key: "VTR_TEST_OPTIONS"
61+
value: "-show_failures"
62+
}
63+
64+
env_vars {
65+
key: "NUM_CORES"
66+
value: "8"
67+
}

‎doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ recommonmark
1313
sphinx-markdown-tables
1414

1515
# Handle markdown cross-references
16-
git+https://github.com/SymbiFlow/sphinxcontrib-markdown-symlinks@bd0869b817568dce268bcdc3dc3dc7a7bd40c392
16+
git+https://github.com/SymbiFlow/sphinxcontrib-markdown-symlinks
1717

1818
#Handle references in bibtex format
1919
#

‎doc/src/conf.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,9 @@
8282
# Add any paths that contain templates here, relative to this directory.
8383
templates_path = []
8484

85-
# Support rendering Markdown docs
86-
source_parsers = {
87-
".md": "markdown_code_symlinks.LinkParser",
88-
}
89-
9085
# The suffix(es) of source filenames.
9186
# You can specify multiple suffix as a list of string:
92-
source_suffix = [".rst", ".md"]
87+
source_suffix = [".rst"]
9388

9489
# The encoding of source files.
9590
# source_encoding = 'utf-8-sig'
@@ -379,6 +374,21 @@
379374
assert os.path.exists(prjdir) == True, "Regenerate doxygen XML for {}".format(prjname)
380375

381376

377+
def recommonmark_setup(app):
378+
"""Initialize Sphinx extension."""
379+
import sphinx
380+
381+
if sphinx.version_info >= (1, 8):
382+
app.add_source_suffix(".md", "markdown")
383+
app.add_source_parser(LinkParser)
384+
385+
return {"version": recommonmark.__version__, "parallel_read_safe": True}
386+
387+
388+
# Override recommonmark setup
389+
recommonmark.setup = recommonmark_setup
390+
391+
382392
def setup(app):
383393
github_code_repo = "https://github.com/verilog-to-routing/vtr-verilog-to-routing/"
384394
github_code_branch = "blob/master/"

0 commit comments

Comments
 (0)