diff options
| author | Adam Izraelevitz | 2020-09-24 10:00:23 -0700 |
|---|---|---|
| committer | GitHub | 2020-09-24 10:00:23 -0700 |
| commit | 0e87d8efb8c3a3726796af4a4b8b57e7eeb81be7 (patch) | |
| tree | 4cf765ee979e71fa76c0e5a2b5c6bc8577a380cf | |
| parent | 9c4f14fb7347b5ca6afe777a9a4c5d9d15f9ac0d (diff) | |
Fix broken mdoc (#1600)
* Fix broken mdoc
* Added test-chisel-docs to ci workflow
| -rw-r--r-- | .circleci/config.yml | 6 | ||||
| -rw-r--r-- | docs/src/cookbooks/naming.md | 2 | ||||
| -rw-r--r-- | docs/src/explanations/naming.md | 2 |
3 files changed, 7 insertions, 3 deletions
diff --git a/.circleci/config.yml b/.circleci/config.yml index 238beb09..cc5c0225 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -141,13 +141,14 @@ jobs: test-chisel-docs: executor: chisel-executor + steps: - attach_workspace: at: /home/chisel - run: command: | - sbt $SBT_ARGS "docs/mdoc" + (cd chisel3 && cat /dev/null | sbt $SBT_ARGS "docs/mdoc") test-chisel-2_11: executor: chisel-executor @@ -178,4 +179,7 @@ workflows: - test-chisel-2_12: requires: - build-treadle + - test-chisel-docs: + requires: + - build-treadle diff --git a/docs/src/cookbooks/naming.md b/docs/src/cookbooks/naming.md index 5f57826f..604843aa 100644 --- a/docs/src/cookbooks/naming.md +++ b/docs/src/cookbooks/naming.md @@ -58,5 +58,5 @@ class ExampleNoPrefix extends MultiIOModule { out := add } -println(ChiselStage.emitVerilog(new Example7)) +println(ChiselStage.emitVerilog(new ExampleNoPrefix)) ``` diff --git a/docs/src/explanations/naming.md b/docs/src/explanations/naming.md index 69870813..56c089bc 100644 --- a/docs/src/explanations/naming.md +++ b/docs/src/explanations/naming.md @@ -213,7 +213,7 @@ reflection naming cannot: ```scala mdoc class Example10 extends MultiIOModule { { - val in = IO(Input(UInt(width.W))) + val in = IO(Input(UInt(3.W))) val out = IO(Output(UInt())) val add = in + in |