Don't use mdinclude for code-of-conduct and contributing

py-mine · Feb 7, 2023 · 9e7e7d6 · 9e7e7d6
1 parent bba8589
commit 9e7e7d6
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/docs/pages/code-of-conduct.rst b/docs/pages/code-of-conduct.rst
@@ -1,8 +1,11 @@
 Code of Conduct
 ===============
 
-.. mdinclude:: ../../CODE-OF-CONDUCT.md
-
 ..
     TODO: Rewrite the code of conduct here directly, rather than including it
     like this, and just include a link to the docs in CODE-OF-CONDUCT.md
+
+    Temporarily using ``.. mdinclude:: ../../CODE-OF-CONDUCT.md`` doesn't work,
+    as it contains multiple references to same URLs,  and while m2r2 has
+    --anonymous-references option, it doesn't seem like it's possible to use it
+    with .. mdinclude
diff --git a/docs/pages/contributing.rst b/docs/pages/contributing.rst
@@ -1,8 +1,11 @@
 Contributing Guidelines
 =======================
 
-.. mdinclude:: ../../CONTRIBUTING.md
-
 ..
     TODO: Rewrite CONTRIBUTING.md here directly, rather than including it
     like this, and just include a link to the docs in CONTRIBUTING.md
+
+    Temporarily using ``.. mdinclude:: ../../CONTRIBUTING.md`` doesn't work,
+    as it contains multiple references to same URLs,  and while m2r2 has
+    --anonymous-references option, it doesn't seem like it's possible to use it
+    with .. mdinclude