SpinalDoc-RTD
SpinalDoc-RTD copied to clipboard
SpinalHDL
The sources of the online SpinalHDL doc
- [x] Is it still true? - [ ] Suggested location: [When/Switch/Mux — SpinalHDL documentation](https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Semantic/when_switch.html) (source: [Semantic/when_switch.rst](https://github.com/SpinalHDL/SpinalDoc-RTD/blob/master/source/SpinalHDL/Semantic/when_switch.rst)) - [ ] Document limitation and explain why - [ ] Add workaround...
Tests are being moved to specific folder so this line should be updated. Note: this is an untested quickfix from GH web interface
The goal is to both: * Make it easier for all people discovering SpinalHDL (knowing VHDL and Verilog might help but it is not a requirement) * Make it easier...
Do not merge until SpinalHDL/SpinalHDL#981 has not been merged
Do not merge until SpinalHDL/SpinalHDL#968 has not been merged - [ ] Mention late evaluation done not before the `it compiles` test (so assertions to build component are delayed)
Spinal enables representing the code in a way which is not possible in RTL. This section would show idioms which are useful in Spinal. For each idiom, it would explain...
See https://github.com/SpinalHDL/SpinalHDL/pull/940
https://github.com/SpinalHDL/SpinalDoc-RTD/blob/master/source/SpinalHDL/Libraries/fragment.rst - [ ] How to use it with example - [ ] Warning about `getWidth` - [ ] Seek for other similar implicit conversions (Stream, Flow, etc.) and document...
Should be in: https://spinalhdl.github.io/SpinalDoc-RTD/master/SpinalHDL/Sequential%20logic/registers.html (source: https://github.com/SpinalHDL/SpinalDoc-RTD/blob/master/source/SpinalHDL/Sequential%20logic/registers.rst) Simplified example: ```scala val inFrameLate = Reg(Bool) setWhen(!sclRead) clearWhen(!inFrame) ```