Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support building mdoc through Mill on dev #3312

Open
michael-etzkorn opened this issue Mar 20, 2023 · 1 comment
Open

Support building mdoc through Mill on dev #3312

michael-etzkorn opened this issue Mar 20, 2023 · 1 comment

Comments

@michael-etzkorn
Copy link
Contributor

Type of issue: feature request

Impact: no functional change

Development Phase: request

Other information

What is the current behavior?
Since merging 0b7fef4, the steps to build mdoc are no longer supported and need a Mill build equivalent to check the mdoc against the latest dev branch.

@FurryAcetylCoA
Copy link

FurryAcetylCoA commented Feb 25, 2024

We can use yoohaemin/mill-mdoc to generate mdoc with mill. Note: the readme.md in this fork is not up to date. com.yoohaemin::mill-mdoc::0.0.3-7-355e3e-SNAPSHOT is the first release compatible with mill 0.11.

However, I'm not sure were to mix the MDocModule trait in. I tried to mix it with RocketChip and while it did compile the docs but it failed at emitting SystemVerilog(adder_tutorial.md:315). This issue arises because chisel5 compilation requires the plugin, and 'm not familiar with build.sc structure used by rocketchip. I don't know how to fix it ( should I just use another object extended from RocketChip ? )

Also, there are problems with executing ChiselStage.elaborate(top.module) in select_tutorial.md:80 even after adjusting the package path. I believe it has something to do with the internal API change of chisel, which, unfortunately, I'm also not familiar with.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants