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

Create initial documentation #68

Open
3 tasks
joshuadavidthomas opened this issue Nov 4, 2022 · 1 comment
Open
3 tasks

Create initial documentation #68

joshuadavidthomas opened this issue Nov 4, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@joshuadavidthomas
Copy link
Collaborator

  • Sphinx w/ Myst Parser
  • Furo theme
  • Hosted on Read The Docs
@joshuadavidthomas joshuadavidthomas added the documentation Improvements or additions to documentation label Nov 4, 2022
@joshuadavidthomas
Copy link
Collaborator Author

joshuadavidthomas commented Nov 5, 2022

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.

Would be a real pain to do this any other way. pic.twitter.com/d8cckhxmdw

— Will “it’s terminal”🧛‍♂️ McGugan (@willmcgugan) November 5, 2022

It's a custom plugin for mkdocs BTW

Here's a relevant excerpt from the docs that generates the terminal above. pic.twitter.com/50BA5Y54H8

— Will “it’s terminal”🧛‍♂️ McGugan (@willmcgugan) November 5, 2022

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.

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

No branches or pull requests

1 participant