-
Notifications
You must be signed in to change notification settings - Fork 207
Add using on Read The Docs instructions #156
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
base: master
Are you sure you want to change the base?
Add using on Read The Docs instructions #156
Conversation
|
||
A `docs/requirements.txt` with at least this content: | ||
|
||
```txt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code name needs to relate to a pygments lexer: https://pygments.org/docs/lexers/ (not sure what the best one for this is though?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if plain ``` will look OK, then that i think? If not the notmuch
email should work.
Thanks @mlncn some review comments above, also you may want to look at https://myst-parser.readthedocs.io/en/latest/develop/contributing.html#code-style, to ensure that the pre-commit check pass before commiting |
Thanks for the contribution! Given how common it is for people to use RTD, do you think we could instead append this content as a final section to the getting started page? (https://myst-parser.readthedocs.io/en/latest/using/intro.html) |
Yeh I wouldn't be adverse to that |
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
Will shift to appending and finally get this wrapped up later tonight! |
Hey @mlncn, is there any help you'd need to move this forward, or is the blocker just the number of hours in a day? :) |
@pradyunsg whoops yeah i should not be the blocker on this if you'd be willing to put the documentation updates in the right place! Thank you! |
Hi folks, I would be happy to move this forward :) If @mincn ran out of stamina, may I open a new pull request with their commits? |
Well I certainly won't stop you 😄 |
@astrojuanlu go for it - happy to review docs PRs 👍 |
This is a start to addressing #155