support markdown

pyvec · Aug 25, 2023 · 7259542 · 7259542
1 parent 2ec1d94
commit 7259542
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -27,6 +27,13 @@ Běžná práce
 #. V editoru upravujete texty a v prohlížeči si kontrolujete výsledek
 #. Projekt zastavíte v terminálu pomocí :kbd:`Ctrl+C`
 
+Markdown
+^^^^^^^^
+
+Původně byla dokumentace psaná v reStructuredText. Nyní ale podporuje i Markdown. Asi zatím nebudeme přepisovat původní stránky, ale pokud chce někdo napsat něco nového, a vyhovoval by mu spíš Markdown, nechť klidně použije Markdown.
+
+Kdyby s tím byl nějaký problém, tady je `návod na kombo Sphinx + MyST <https://docs.readthedocs.io/en/stable/guides/migrate-rest-myst.html>`__.
+
 Emoji
 ^^^^^
 

diff --git a/conf.py b/conf.py
@@ -39,6 +39,7 @@
     'slack',
     'twitter',
     'gh_repo',
+    'myst_parser',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -48,7 +49,7 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
 
 # The master toctree document.
 master_doc = 'index'

diff --git a/requirements.txt b/requirements.txt
@@ -7,3 +7,4 @@ requests==2.31.0
 jinja2==3.1.2
 strictyaml==1.7.3
 pytest==7.4.0
+myst-parser==2.0.0