Skip to content

Commit 310c5af

Browse files
committed
Add GitHub integration to documentation
- Add "Edit on GitHub" and "View Source" buttons via Furo theme settings - Add GitHub and Report Issue icons to documentation footer - Create documentation-specific issue template for reporting docs bugs Users can now easily edit documentation pages or report issues directly from the ReadTheDocs site. Underworld development team with AI support from Claude Code
1 parent 21148a8 commit 310c5af

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Documentation Issue
3+
about: Report an error, typo, or improvement for the documentation
4+
title: '[Docs] '
5+
labels: documentation
6+
assignees: ''
7+
---
8+
9+
## Page URL
10+
<!-- Paste the URL of the documentation page with the issue -->
11+
12+
13+
## Description
14+
<!-- Describe the problem or suggested improvement -->
15+
16+
17+
## Suggested Fix
18+
<!-- If you know how to fix it, describe the correction -->
19+
20+
21+
## Additional Context
22+
<!-- Any other information that might help -->
23+

docs/conf.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,34 @@
113113
},
114114
"sidebar_hide_name": False,
115115
"navigation_with_keys": True,
116+
# GitHub integration - Edit/View Source buttons
117+
"source_repository": "https://github.com/underworldcode/underworld3",
118+
"source_branch": "development",
119+
"source_directory": "docs/",
120+
# Footer icons
121+
"footer_icons": [
122+
{
123+
"name": "GitHub",
124+
"url": "https://github.com/underworldcode/underworld3",
125+
"html": """
126+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
127+
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path>
128+
</svg>
129+
""",
130+
"class": "",
131+
},
132+
{
133+
"name": "Report Issue",
134+
"url": "https://github.com/underworldcode/underworld3/issues/new?labels=documentation&template=docs-issue.md",
135+
"html": """
136+
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
137+
<path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z"></path>
138+
<path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z"></path>
139+
</svg>
140+
""",
141+
"class": "",
142+
},
143+
],
116144
}
117145

118146
# =============================================================================

0 commit comments

Comments
 (0)