From ee57ad334e69571c609c5ed0444e1fcb3d3fd8e1 Mon Sep 17 00:00:00 2001
From: Aaron Carlisle <carlisle.b3d@gmail.com>
Date: Thu, 7 Dec 2023 22:06:07 +0100
Subject: [PATCH] Docs: Add button to report python API documentation issue

Adds a button similar to the user manual at the bottom of each page.
This is done to give people a place to report issues other than the documentation repository which should be limited to the user manual.

With this change also comes a new issue template with helpful text and a redirect for people looking to submit an issue with Blender.

I would also like to add a Documentation label too but that requires configuring with the Gitea project.

Pull Request: https://projects.blender.org/blender/blender/pulls/115865
---
 .gitea/issue_template/api_docs.yaml  | 39 ++++++++++++++++++++++++++++
 doc/python_api/templates/footer.html | 14 ++++++++++
 2 files changed, 53 insertions(+)
 create mode 100644 .gitea/issue_template/api_docs.yaml
 create mode 100644 doc/python_api/templates/footer.html

diff --git a/.gitea/issue_template/api_docs.yaml b/.gitea/issue_template/api_docs.yaml
new file mode 100644
index 00000000000..d9dd642240c
--- /dev/null
+++ b/.gitea/issue_template/api_docs.yaml
@@ -0,0 +1,39 @@
+name: Python API Documentation
+about: File a bug report for the python API documentation
+labels:
+  - "Type/Report"
+  - "Status/Needs Triage"
+  - "Priority/Normal"
+body:
+  - type: markdown
+    attributes:
+      value: |
+                ### Instructions
+                Thank you for reporting an issue with Blender's Python API documentation.
+                If you meant to file an issue with the software please create a normal [bug report](https://projects.blender.org/blender/blender/issues/new?template=.gitea%2fissue_template%2fbug.yaml).
+
+                Please add to the description below explain the issue at hand.
+                Use **Report issue on this page** at the bottom of the page with an issue to autofill some information.
+
+                Including details, examples, or suggested fixes are appreated and will help resolve the issue as soon as possible.
+
+  - type: textarea
+    id: body
+    attributes:
+      label: "Description"
+      hide_label: true
+      value: |
+               **Page Information**
+               Blender Version: (example: 4.0, edbf15d3c044, main)
+               [Permanent Link](https://docs.blender.org/api/current/) (Update me to the URL of the page with an issue)
+
+               **Short description of issue**
+               [Please fill out a short description of the issue here]
+
+
+  - type: markdown
+    attributes:
+      value: |
+                ### Help the developers
+
+                Bug fixing is important, the developers will handle reports swiftly. For that reason, carefully provide exact steps and a **small and simple Python scipt** if neccesarry to reproduce the problem. You do your half of the work, then we do our half!
diff --git a/doc/python_api/templates/footer.html b/doc/python_api/templates/footer.html
new file mode 100644
index 00000000000..c31961acd06
--- /dev/null
+++ b/doc/python_api/templates/footer.html
@@ -0,0 +1,14 @@
+{# For the "Report Issue" button on the bottom of pages. #}
+{%- extends "!footer.html" %}
+{%- block extrafooter %}
+{%- if not pagename in ("search", "404", "genindex") and hasdoc(pagename) %}
+<div class="footer-contribute">
+    <ul>
+        <li>
+            <a href="https://projects.blender.org/blender/blender/issues/new?template=.gitea/issue_template/api_docs.yaml&field:body=%2A%2APage+Information%2A%2A%0D%0AFile%3A+%60{{ pagename }}{{ page_source_suffix }}%60%0D%0ABlender+Version%3A+%60{{ version }}%60%0D%0A%5BPermanent+Link%5D%28https%3A%2F%2Fdocs.blender.org%2Fapi%2F{{ version }}%2F{{ pagename }}{{ file_suffix }}%29%0D%0A%0D%0A%2A%2AShort+description+of+error%2A%2A%0D%0A%5BPlease+fill+out+a+short+description+of+the+error+here%5D%0D%0A"
+                class="fa fa-bug"> {{ _('Report issue on this page') }}</a>
+        </li>
+    </ul>
+</div>
+{%- endif %}
+{% endblock %}
\ No newline at end of file