Skip to content

Add using on Read The Docs instructions#156

Open
mlncn wants to merge 4 commits intoexecutablebooks:masterfrom
agaric:155-instruction-for-using-on-rtd
Open

Add using on Read The Docs instructions#156
mlncn wants to merge 4 commits intoexecutablebooks:masterfrom
agaric:155-instruction-for-using-on-rtd

Conversation

@mlncn
Copy link
Copy Markdown

@mlncn mlncn commented Jun 3, 2020

This is a start to addressing #155

Comment thread docs/using/on_rtd.md

A `docs/requirements.txt` with at least this content:

```txt
Copy link
Copy Markdown
Member

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?)

Copy link
Copy Markdown
Author

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.

Comment thread docs/using/on_rtd.md Outdated
@chrisjsewell
Copy link
Copy Markdown
Member

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

@choldgraf
Copy link
Copy Markdown
Member

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)

@chrisjsewell
Copy link
Copy Markdown
Member

Yeh I wouldn't be adverse to that

@chrisjsewell chrisjsewell linked an issue Jun 3, 2020 that may be closed by this pull request
@mlncn
Copy link
Copy Markdown
Author

mlncn commented Jun 18, 2020

Will shift to appending and finally get this wrapped up later tonight!

@pradyunsg
Copy link
Copy Markdown
Member

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? :)

@mlncn
Copy link
Copy Markdown
Author

mlncn commented Dec 21, 2020

@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!

@astrojuanlu
Copy link
Copy Markdown
Contributor

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?

@chrisjsewell
Copy link
Copy Markdown
Member

Well I certainly won't stop you 😄

@choldgraf
Copy link
Copy Markdown
Member

@astrojuanlu go for it - happy to review docs PRs 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Instructions for using on RTD

5 participants