Add CONTRIBUTING doc to documentation

ferdnyc · ptmcg · commit bc85843414aa · 2025-07-20T21:49:25.000-05:00
- Enable the `myst_parser` Python package as a Sphinx extension,
  which enables it to include MarkDown files in the documentation.
- Add `myst_parser` to `docs/requirements.txt` so that it's installed
  by ReadTheDocs and anyone else looking to build documentation.
- Symlink `CONTRIBUTING.md` into the `docs/` dir (this needs to be
  tested against ReadTheDocs; it may or may not work)
- Add `CONTRIBUTING` to the `index.rst` toctree.
- Update the title from "CONTRIBUTING" to "Contributing to Pyparsing".
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-# CONTRIBUTING
+# Contributing to Pyparsing
 
 Thank you for your interest in working on pyparsing! Pyparsing has become a popular module for creating simple
 text parsing and data scraping applications. It has been incorporated in several widely-used packages, and is
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1 @@
+../CONTRIBUTING.md
diff --git a/docs/conf.py b/docs/conf.py
@@ -41,14 +41,18 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "myst_parser",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffixes:
-source_suffix = {'.rst': 'restructuredtext'}
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
 
 # The master toctree document.
 master_doc = "index"
@@ -200,3 +204,5 @@
 autodoc_default_options = {
     'class-doc-from': 'both',
 }
+
+myst_heading_anchors = 3
diff --git a/docs/index.rst b/docs/index.rst
@@ -17,6 +17,7 @@ Release v\ |version|
    whats_new_in_3_1
    whats_new_in_3_0_0
    pyparsing
+   CONTRIBUTING
    CODE_OF_CONDUCT
 
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,3 @@
 sphinx < 8.2
+myst-parser
+

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# CONTRIBUTING`
	`1`	`+# Contributing to Pyparsing`
`2`	`2`
`3`	`3`	`Thank you for your interest in working on pyparsing! Pyparsing has become a popular module for creating simple`
`4`	`4`	`text parsing and data scraping applications. It has been incorporated in several widely-used packages, and is`