Skip to content

Commit dbbf115

Browse files
jeremymanningclaude
andcommitted
Fix Edit on GitHub links - correct github_url configuration
- Set github_url to full path: https://github.com/ContextLab/clustrix/blob/master/docs/source/ - Add .readthedocs.yaml for explicit ReadTheDocs configuration - Add docs/requirements.txt for documentation dependencies - Remove unnecessary custom templates and html_context overrides Following sphinx-wagtail-theme documentation for proper GitHub link configuration. This ensures Edit on GitHub links work correctly on ReadTheDocs. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 16dde2b commit dbbf115

File tree

3 files changed

+18
-8
lines changed

3 files changed

+18
-8
lines changed

.readthedocs.yaml

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
2-
1+
# .readthedocs.yaml
32
# Read the Docs configuration file
43
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
54

65
# Required
76
version: 2
87

9-
# Set the OS, Python version, and other tools you might need
8+
# Set the OS, Python version and other tools you might need
109
build:
11-
os: ubuntu-24.04
10+
os: ubuntu-22.04
1211
tools:
1312
python: "3.12"
1413

15-
# Build documentation in the "docs/" directory with Sphinx
14+
# Build documentation in the docs/ directory with Sphinx
1615
sphinx:
1716
configuration: docs/source/conf.py
1817

19-
# Install the package with docs dependencies
18+
# If using Sphinx, optionally build your docs in additional formats such as PDF
19+
formats: all
20+
21+
# Optionally declare the Python requirements required to build your docs
2022
python:
2123
install:
24+
- requirements: docs/requirements.txt
2225
- method: pip
2326
path: .
2427
extra_requirements:
25-
- docs
28+
- docs

docs/requirements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sphinx>=4.0
2+
sphinx-wagtail-theme>=6.0.0
3+
sphinx-autodoc-typehints>=1.12
4+
nbsphinx>=0.8
5+
jupyter>=1.0
6+
ipython>=7.0

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,11 @@
4646
# Wagtail theme options
4747
html_theme_options = {
4848
"project_name": "Clustrix",
49-
"github_url": "https://github.com/ContextLab/clustrix",
49+
"github_url": "https://github.com/ContextLab/clustrix/blob/master/docs/source/",
5050
"footer_links": "GitHub|PyPI",
5151
}
5252

53+
5354
html_title = "Clustrix Documentation"
5455
html_short_title = "Clustrix"
5556

0 commit comments

Comments
 (0)