Skip to content

Commit d8bb995

Browse files
authored
Improve the rst2myst conversion documentation. (#1958)
* Improve the rst2myst conversion documentation. - Remove the `-R` option from the example commands - Add link to CLI reference documentation - Spelling and grammar fixes * Linkcheck
1 parent 72e485c commit d8bb995

File tree

2 files changed

+9
-6
lines changed

2 files changed

+9
-6
lines changed

docs/contributing/documentation/admins.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,18 @@ We did this for `plone.app.dexterity` and several other projects.
4040
1. Delete any non-documentation files from the clone.
4141
1. Move the documentation files and subfolders to the root of the clone, retaining the documentation structure.
4242
1. Convert the reStructuredText documentation files to MyST.
43-
The example commands below assume that there are files at the root of the clone and in one sub-level of nested directories.
44-
For deeper nesting, insert globbing syntax for each sub-level as `**/`
43+
The example commands below assume that there are files at the root of the clone and in one sublevel of nested directories.
44+
For deeper nesting, insert globbing syntax for each sublevel as `**/`.
4545

4646
```shell
47-
bin/rst2myst convert -R project/*.rst
48-
bin/rst2myst convert -R project/**/*.rst
47+
bin/rst2myst convert project/*.rst
48+
bin/rst2myst convert project/**/*.rst
49+
```
50+
```{seealso}
51+
[Command line options for `rst2myst`](https://rst-to-myst.readthedocs.io/en/latest/cli.html)
4952
```
5053

51-
1. Add HTML meta data to the converted files.
54+
1. Add HTML metadata to the converted files.
5255

5356
```shell
5457
cd project

docs/contributing/documentation/myst-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ For an in depth discussion of privacy issues, see [How to embed YouTube videos w
298298
299299
- PeerTube's [Privacy guide](https://docs.joinpeertube.org/admin/privacy-guide) helps administrators comply with terms of government policies.
300300
- YouTube's [Manage video embedding options, Turn on privacy-enhanced mode](https://support.google.com/youtube/answer/171780)
301-
- Vimeo's [supported player parameters](https://help.vimeo.com/hc/en-us/articles/12426260232977-About-Player-parameters#h_01FNYA7F7GKWE17XDQJPMBC058)
301+
- Vimeo's [supported player parameters](https://help.vimeo.com/hc/en-us/articles/12426260232977-About-Player-Parameters)
302302
```
303303

304304
```{seealso}

0 commit comments

Comments
 (0)