docs: fix generation using markdown

Lewiscowles1986 · Mar 31, 2024 · 666dbba · 666dbba
1 parent 37071fd
commit 666dbba
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,13 +28,16 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', 'myst_parser']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'
@@ -44,7 +47,7 @@
 
 # General information about the project.
 project = u'Python Call Graph'
-copyright = u'2007-2013 Gerald Kaszuba, et al.'
+copyright = u'2007-2024 Gerald Kaszuba, et al.'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,8 +1,9 @@
-.. include:: ../README.md
-
 Documentation Index
 ===================
 
+.. include:: ../README.md
+   :parser: markdown
+
 .. toctree::
     :maxdepth: 3
 

diff --git a/man/pycallgraph.1 b/man/pycallgraph.1
@@ -149,6 +149,6 @@ pycallgraph was written by Gerald Kaszuba <[email protected]>.
 This manual page was originally written by Jan Alonzo <[email protected]>, for the Debian GNU/Linux system.
 
 .SH COPYRIGHT
-2007-2013 Gerald Kaszuba, et al.
+2007-2024 Gerald Kaszuba, et al.
 .\" Generated by docutils manpage writer.
 .
diff --git a/requirements/documentation.txt b/requirements/documentation.txt
@@ -1 +1,2 @@
 sphinx==7.2.6
+myst-parser==2.0.0