docs: adjust how files are referenced in docs to allow for both the generated sphinx and github files to link correctly

56kyle · 56kyle · commit 89c82d5d6f1f · 2025-07-27T15:45:03.000-04:00
diff --git a/{{cookiecutter.project_name}}/CONTRIBUTING.md b/{{cookiecutter.project_name}}/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 Thank you for considering contributing to the `cookiecutter-robust-python` template! We welcome contributions that help improve the template, keep its tooling current, and enhance its documentation.
 
-By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md).
+By participating in this project, you are expected to uphold our [Code of Conduct].
 
 ## How to Contribute
 
@@ -38,3 +38,7 @@ If your contribution involves updating a major tool version or suggesting a diff
 For questions or discussion about contributions, open an issue or a discussion on the [GitHub repository](https://github.com/56kyle/cookiecutter-robust-python).
 
 ---
+
+<!-- github-only -->
+
+[code of conduct]: CODE_OF_CONDUCT.md
diff --git a/{{cookiecutter.project_name}}/docs/codeofconduct.md b/{{cookiecutter.project_name}}/docs/codeofconduct.md
@@ -1,5 +1,3 @@
-# Code of Conduct
-
 ```{include} ../CODE_OF_CONDUCT.md
 
 ```
diff --git a/{{cookiecutter.project_name}}/docs/contributing.md b/{{cookiecutter.project_name}}/docs/contributing.md
@@ -1,6 +1,10 @@
 # Contributing
 
 ```{include} ../CONTRIBUTING.md
+---
+start-after: # Contributing to {{cookiecutter.package_name}}
+end-before: <!-- github-only -->
+---
 
 ```
 

-Original file line number
+Diff line change
@@ @@ -1,5 +1,3 @@ @@
 -# Code of Conduct
+-
 ```{include} ../CODE_OF_CONDUCT.md
 ```