Closed mgielda closed 5 years ago
Although the aim of the above is different. For our needs, it should be possible to extract code snippets from the docs programmatically using docutils. Need to figure out:
OK, did it the other way. Used .. literalinclude::
to fetch content from automated scripts in the RISC-V Getting Started Guide (see https://github.com/riscv/risc-v-getting-started-guide/blob/master/source/getting-zephyr.rst). This seems like a good option, so far it's working fine. This will allow us to write CI scripts which run the scripts that are being used in the docs.
GitHubThe official RISC-V getting started guide. Contribute to riscv/risc-v-getting-started-guide development by creating an account on GitHub.
CI testing of SymbiFlow tutorials
Brief explanation
Find a way to ensure the tutorials for SymbiFlow are tested in CI.
Expected results
There exists a relatively easy way to tag code snippets to be executed in order, possibly a way to supply some extra commands on top of what's exposed to the user. Might be needed to find a way to substitute variables. Alternative (less nice) - in every repo with a tutorial there is an easily executable script (or scripts) mirroring the commands in the tutorial, co-maintained with the repo. A clear methodology is devised to lead the way.
Detailed Explanation
The problem with tutorials in fast moving projects is that they became outdated very easily. We need to figure out a way to test them so that we can keep the tutorials up to date.
Knowledge Prerequisites