joshuadavidthomas
commented
2 years ago - [ ] Sphinx w/ Myst Parser
- [ ] Furo theme
- [ ] Hosted on Read The Docs
Open joshuadavidthomas opened 2 years ago
joshuadavidthomas
commented
2 years ago joshuadavidthomas
commented
2 years ago It would be nice to have a gallery of some kind showing off the different features of the software, using a something like @willmcgugan shows off in these tweets:
Love being able to capture terminal output in docs.
— Will “it’s terminal”🧛♂️ McGugan (@willmcgugan) November 5, 2022
Would be a real pain to do this any other way. pic.twitter.com/d8cckhxmdw
It's a custom plugin for mkdocs BTW
— Will “it’s terminal”🧛♂️ McGugan (@willmcgugan) November 5, 2022
Here's a relevant excerpt from the docs that generates the terminal above. pic.twitter.com/50BA5Y54H8
https://twitter.com/willmcgugan/status/1588914499049775105
They are using Mkdocs in the textual repo, but I'm sure there's some way to do the same thing in Sphinx. Or we could just use Mkdocs and adapt what they've done.