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.

Sign up for GitHub

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 step for MyST Parser #182

Merged
merged 2 commits into from
Nov 21, 2023
Merged

add step for MyST Parser #182

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab2949d
add step for MyST Parser
roboparker Jul 11, 2023
a815ccf
Merge branch 'main' into pip-install-myst_parser
RCheesley Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,10 @@
1. Install Python 3 for your OS if not already installed
2. Install Sphinx `pip install sphinx`
3. Install sphinx-rtd-theme `pip install sphinx-rtd-theme`
4. CD into the docs directory `cd [path to this repo]/docs`
5. Run `make html`
6. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.
4. Install MyST Parser `pip install myst_parser`
5. CD into the docs directory `cd [path to this repo]/docs`
6. Run `make html`
7. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.

Check warning on line 68 in README.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.

Raw Output:
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "README.md", "range": {"start": {"line": 68, "column": 9}}}, "severity": "WARNING"}

Check failure on line 68 in README.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'HTML' instead of 'html'.

Raw Output:
{"message": "[Vale.Terms] Use 'HTML' instead of 'html'.", "location": {"path": "README.md", "range": {"start": {"line": 68, "column": 42}}}, "severity": "ERROR"}

Check failure on line 68 in README.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'HTML' instead of 'html'.

Raw Output:
{"message": "[Vale.Terms] Use 'HTML' instead of 'html'.", "location": {"path": "README.md", "range": {"start": {"line": 68, "column": 99}}}, "severity": "ERROR"}

Check failure on line 68 in README.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'HTML' instead of 'html'.

Raw Output:
{"message": "[Vale.Terms] Use 'HTML' instead of 'html'.", "location": {"path": "README.md", "range": {"start": {"line": 68, "column": 123}}}, "severity": "ERROR"}

Check failure on line 68 in README.md

View workflow job for this annotation

GitHub Actions / prose 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'HTML' instead of 'html'.

Raw Output:
{"message": "[Vale.Terms] Use 'HTML' instead of 'html'.", "location": {"path": "README.md", "range": {"start": {"line": 68, "column": 134}}}, "severity": "ERROR"}

### Vale
Before pushing, run Vale and address suggestions and errors as applicable.
Expand Down