-
Notifications
You must be signed in to change notification settings - Fork 198
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
Add using on Read The Docs instructions #156
Open
mlncn
wants to merge
4
commits into
executablebooks:master
Choose a base branch
from
agaric:155-instruction-for-using-on-rtd
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Using on ReadTheDocs | ||
|
||
This page describes how to get started with using the MyST parser for documentation generated by and hosted on [Read the Docs](https://readthedocs.org/), which "simplifies software documentation by automating building, versioning, and hosting of your docs for you". | ||
|
||
## Example minimal setup | ||
|
||
A `.readthedocs.yml` file with this content: | ||
|
||
```yaml | ||
version: 2 | ||
sphinx: | ||
configuration: docs/conf.py | ||
python: | ||
version: 3 | ||
install: | ||
- requirements: docs/requirements.txt | ||
``` | ||
|
||
```{tip} | ||
See [Read The Docs' configuration file documentation](https://docs.readthedocs.io/en/stable/config-file/index.html) for more | ||
``` | ||
|
||
A `docs/requirements.txt` with at least this content: | ||
|
||
```txt | ||
myst-parser[sphinx] | ||
``` | ||
|
||
A `docs/conf.py` file with at least this content: | ||
|
||
```python | ||
extensions = [ | ||
'myst_parser', | ||
] | ||
|
||
source_suffix = ['.rst', '.md'] | ||
``` | ||
|
||
```{tip} | ||
Use `sphinx-quickstart` to create your `conf.py` file and make the above modifications; see [Getting Started with Sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html#quick-start) for more. Just remember that to enable markdown-formatted documentation, you're using MyST Parser *instead* of ReCommonMark. (You still get all of CommonMark, and more!) | ||
``` | ||
|
||
And now you're good to go, using MyST for your Sphinx-powered, ReadTheDocs-hosted documentation! | ||
|
||
```{seealso} | ||
- [Read the Docs documentation](https://docs.readthedocs.io/en/stable/index.html) | ||
- {ref}`The MyST Syntax Guide <using/syntax>` | ||
mlncn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.