Skip to content

Commit 2156d25

Browse files
committed
Remove duplicate 'Architecture Topics' listings in Sphinx docs
- Remove 'Available Topics' section from architecture/index.md generation - Use toctree with caption instead of manual topic list - Simplify index.md sidebar hierarchy to avoid duplication - toctree now serves as single source of truth for topic navigation
1 parent 83fdff2 commit 2156d25

6 files changed

Lines changed: 2 additions & 42 deletions

File tree

doc/source/architecture/dependencies.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,6 @@
1212
- Understand JavaScript dependency management
1313
- Learn about the wheels server
1414

15-
## Dependencies
16-
17-
18-
1915
## Dependencies - Python
2016

2117
`script/common_startup.sh` sets up a `virtualenv` with required dependencies in `$GALAXY_ROOT/.venv` (or `$GALAXY_VIRTUAL_ENV` if set).

doc/source/architecture/index.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Core documentation about Galaxy's internal architecture and design.
44

55
```{toctree}
66
:maxdepth: 1
7+
:caption: Architecture Topics
78
89
ecosystem
910
project-management
@@ -19,21 +20,3 @@ dependencies
1920
startup
2021
production
2122
```
22-
23-
## Available Topics
24-
25-
This section documents Galaxy's key architectural patterns:
26-
27-
- **[Galaxy Ecosystem and Projects](ecosystem.md)**
28-
- **[Galaxy Project Management and Contribution](project-management.md)**
29-
- **[Galaxy Architecture Principles](principles.md)**
30-
- **[Galaxy Files and Directory Structure](files.md)**
31-
- **[Galaxy Web Frameworks](frameworks.md)**
32-
- **[Dependency Injection in Galaxy](dependency-injection.md)**
33-
- **[Galaxy Task Management with Celery](tasks.md)**
34-
- **[Galaxy Application Components: Models, Managers, and Services](application-components.md)**
35-
- **[Galaxy Plugin Architecture](plugins.md)**
36-
- **[Galaxy Client Architecture](client.md)**
37-
- **[Galaxy Dependencies Management](dependencies.md)**
38-
- **[Galaxy Startup Process](startup.md)**
39-
- **[Galaxy Production Deployment](production.md)**

doc/source/architecture/production.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
- Understand multi-process and multi-host setups
1414
- Learn about usegalaxy.org infrastructure
1515

16-
## Production Galaxy - usegalaxy.org
17-
18-
19-
2016
#### Default
2117

2218
SQLite

doc/source/architecture/startup.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
- Understand dependency installation
1414
- Learn about database migrations and plugin loading
1515

16-
## Galaxy Startup Process
17-
18-
19-
2016
## Cloning Galaxy
2117

2218
```bash

doc/source/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ This section documents Galaxy's internal architecture and design patterns.
44

55
```{toctree}
66
:maxdepth: 2
7-
:caption: Architecture Topics
87
98
architecture/index
109
```

outputs/sphinx-docs/build.py

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -485,22 +485,12 @@ def update_architecture_index(topics_to_include: list[str]) -> None:
485485
486486
```{{toctree}}
487487
:maxdepth: 1
488+
:caption: Architecture Topics
488489
489490
{toctree_items}
490491
```
491-
492-
## Available Topics
493-
494-
This section documents Galaxy's key architectural patterns:
495-
496492
"""
497493

498-
# Add links for each topic in order
499-
for topic_id in ordered_topics:
500-
if topic_id in topic_metadata:
501-
metadata = topic_metadata[topic_id]
502-
content += f"- **[{metadata.title}]({topic_id}.md)**\n"
503-
504494
index_file.write_text(content)
505495
print(f"✓ Updated: {index_file}")
506496

0 commit comments

Comments
 (0)