Skip to content

Commit d0971e8

Browse files
committed
rst-to-myst-config: Add config file for rst2myst for conversions
- This covers the most common directives we use. - Usage is in the file
1 parent 4f7b70a commit d0971e8

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

rst-to-myst-config.yaml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# This is a config that can be used with rst2myst. It may need
2+
# adjusting to your needs, but covers the most common CodeRefinery
3+
# extensions:
4+
#
5+
# $ convert --config ../sphinx-lesson/rst-to-myst-config.yaml -S -W content/**.rst
6+
#
7+
# https://rst-to-myst.readthedocs.io/en/latest/usage.html
8+
#
9+
# To verify it got everything, run:
10+
# $ grep -ri eval-rst content/
11+
#
12+
# To add more roles, you can find the internal name using this
13+
# command. Make sure you specify the right extension to load, both in
14+
# this command and added to this list:
15+
# $ rst2myst directives show -e sphinx_tabs.tabs list-table
16+
17+
extensions:
18+
- sphinx_lesson
19+
- sphinx_tabs.tabs
20+
- sphinx_lesson.directives
21+
- sphinx_lesson.exerciselist
22+
sphinx: true
23+
conversions:
24+
prereq: parse_all
25+
sphinx.directives.patches.CSVTable: direct
26+
docutils.parsers.rst.directives.tables.ListTable: direct
27+
28+
sphinx_lesson.directives._BaseCRDirective: parse_all
29+
sphinx_lesson.directives.PrerequisitesDirective: parse_all
30+
sphinx_lesson.directives.DemoDirective: parse_all
31+
sphinx_lesson.directives.Type_AlongDirective: parse_all
32+
sphinx_lesson.directives.ExerciseDirective: parse_all
33+
sphinx_lesson.directives.SolutionDirective: parse_all
34+
sphinx_lesson.directives.HomeworkDirective: parse_all
35+
sphinx_lesson.directives.Instructor_NoteDirective: parse_all
36+
sphinx_lesson.directives.PrerequisitesDirective: parse_all
37+
sphinx_lesson.directives.DiscussionDirective: parse_all
38+
sphinx_lesson.directives.QuestionsDirective: parse_all
39+
sphinx_lesson.directives.ObjectivesDirective: parse_all
40+
sphinx_lesson.directives.KeypointsDirective: parse_all
41+
sphinx_lesson.directives.CalloutDirective: parse_all
42+
sphinx_lesson.directives.ChecklistDirective: parse_all
43+
sphinx_lesson.directives.TestimonialDirective: parse_all
44+
sphinx_lesson.directives.OutputDirective: parse_all
45+
sphinx_lesson.directives.: parse_all
46+
sphinx_lesson.directives.: parse_all
47+
sphinx_lesson.directives.: parse_all
48+
sphinx_lesson.directives.: parse_all
49+
50+
sphinx_lesson.exerciselist.ExerciselistDirective: parse_all
51+
52+
sphinx_tabs.tabs.TabsDirective: parse_all
53+
sphinx_tabs.tabs.TabDirective: parse_all
54+
sphinx_tabs.tabs.GroupTabDirective: parse_all
55+
sphinx_tabs.tabs.CodeTabDirective: parse_argument
56+

0 commit comments

Comments
 (0)