docs: use myst-parser for markdown (#373)

LizardByte · Aug 11, 2024 · b575469 · b575469
1 parent 9f9a7f5
commit b575469
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
 furo==2024.8.6
-m2r2==0.3.3.post2
+myst-parser==4.0.0
 rstcheck[sphinx]==6.2.4
 rstfmt==0.0.14
 Sphinx==7.2.6

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -25,7 +25,7 @@
 
 # -- Project information -----------------------------------------------------
 project = 'LizardByte'
-copyright = f'{datetime.now ().year}, {project}'
+project_copyright = f'{datetime.now ().year}, {project}'
 author = 'ReenigneArcher'
 
 # The full version, including alpha/beta/rc tags
@@ -37,7 +37,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'm2r2',  # enable markdown files
+    'myst_parser',  # enable markdown files
     'sphinx.ext.autosectionlabel',
     'sphinx.ext.todo',  # enable to-do sections
     'sphinx.ext.viewcode',  # add links to view source code
@@ -53,7 +53,10 @@
 exclude_patterns = ['toc.rst']
 
 # Extensions to include.
-source_suffix = ['.rst', '.md']
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/source/developers/code_of_conduct.rst b/docs/source/developers/code_of_conduct.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../../../CODE_OF_CONDUCT.md
+.. include:: ../../../CODE_OF_CONDUCT.md
+   :parser: myst_parser.docutils_