search

YosysHQ / imctk

Incremental Model Checking Toolkit
Other
5 stars 2 forks source link

feat: add doc based on sphinx #19

Closed chenbo-again closed 1 month ago

chenbo-again commented 1 month ago

add sphinx based doc, and use sphinxcontrib-rust as convertor. the mainline of it is not usable for imctk doc build, and I make some fix in https://gitlab.com/chenbott/sphinxcontrib-rust, I will make a merge request later(origin repo: https://gitlab.com/munir0b0t/sphinxcontrib-rust)

chenbo-again commented 1 month ago

you can check the build result in https://github.com/chenbo-again/imctk/tree/tmp/doc/build/crates.

jix commented 1 month ago

This is not how we intend to use sphinx, see my comment at https://github.com/YosysHQ/imctk/issues/2#issuecomment-2439902133