Skip to content

Commit

Permalink
Add support markdown documentation using MyST
Browse files Browse the repository at this point in the history
  • Loading branch information
edparcell committed Aug 30, 2024
1 parent 0417924 commit 4087be6
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx.ext.graphviz'
'sphinx.ext.graphviz',
'myst_parser'
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ User Guide
user/quickstart
user/advanced
user/strategies
user/test

API Reference
-------------
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ sphinx-rtd-theme
pillow
mock
commonmark
recommonmark
recommonmark
myst-parser

0 comments on commit 4087be6

Please sign in to comment.