Skip to content

Commit 785a944

Browse files
committed
Fix various links
This merge also makes warnings report as errors when building the docs and removes references to the autogenerated API. Two unused pages have been removed.
1 parent 17f147a commit 785a944

File tree

8 files changed

+22
-83
lines changed

8 files changed

+22
-83
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ BUILDDIR = _build
1111
# Build into a versioned subdirectory
1212
versioned-html:
1313
@echo "Building version: $(DOCS_VERSION)"
14-
$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)/html/$(DOCS_VERSION)"
14+
$(SPHINXBUILD) -b html -nW --keep-going "$(SOURCEDIR)" "$(BUILDDIR)/html/$(DOCS_VERSION)"
1515
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html/$(DOCS_VERSION)."
1616
@echo "Setting up shared version switcher for local preview..."
1717
mkdir -p _build/html/shared

docs/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@
4242
"sphinx.ext.napoleon",
4343
]
4444

45-
autosummary_generate = ['developers_guide/api.md']
46-
4745
# Otherwise, the Return parameter list looks different from the Parameters list
4846
napoleon_use_rtype = False
4947
# Otherwise, the Attributes parameter list looks different from the Parameters

docs/index.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,23 @@
55
introduction
66
quickstart
77
using-tools
8-
testing-release-candidates
8+
99
releasing/release-workflow
10+
releasing/conda-vs-spack
11+
releasing/planning-updates
12+
releasing/creating-rcs/overview
13+
releasing/creating-rcs/rc-dependencies
14+
releasing/creating-rcs/rc-e3sm-unified
15+
releasing/creating-rcs/rc-troubleshooting
16+
releasing/testing/overview
17+
releasing/testing/spack-updates
18+
releasing/testing/mache-updates
19+
releasing/testing/deploying-on-hpcs
20+
releasing/testing/troubleshooting-deploy
21+
releasing/adding-new-machines
22+
releasing/finalizing-release
23+
releasing/maintaining-past-versions
24+
1025
packages
1126
troubleshooting
1227
contributing

docs/releasing/adding-new-machines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ After updating `mache`, you'll need to:
4444
2. **Update Spack if needed**
4545

4646
* If new versions of external tools are required, update the
47-
[`spack_for_mache_<version>`](spack-updates.md) branch of the
47+
[`spack_for_mache_<version>`](testing/spack-updates.md) branch of the
4848
[E3SM Spack fork](https://github.com/E3SM-Project/spack)
4949

5050
---
5151

5252
## ✅ Testing Your Changes
5353

5454
Use the standard test deployment approach from
55-
[Deploying on HPCs](deploying-on-hpcs.md):
55+
[Deploying on HPCs](testing/deploying-on-hpcs.md):
5656

5757
```bash
5858
cd e3sm_supported_machines
@@ -88,4 +88,4 @@ During testing, focus on:
8888

8989
---
9090

91-
➡ Next: [Publishing the Final Release](publishing-final-release.md)
91+
➡ Next: [Publishing the Final Release](finalizing-release.md)

docs/releasing/maintaining-past-versions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,4 +95,4 @@ because of this.
9595

9696
---
9797

98-
Back to: [Publishing the Final Release](publishing-final-release.md)
98+
Back to: [Publishing the Final Release](finalizing-release.md)

docs/releasing/planning-updates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The final list of packages is curated by the Infrastructure Team based on:
6969
* Community need and usage patterns
7070

7171
Once the list is mostly settled, the team begins creating release candidates
72-
using the [Creating Release Candidates](creating-rcs.md) workflow.
72+
using the [Creating Release Candidates](creating-rcs/overview.md) workflow.
7373

7474
---
7575

docs/testing-release-candidates.md

Whitespace-only changes.

docs/using-toos.md

Lines changed: 0 additions & 74 deletions
This file was deleted.

0 commit comments

Comments
 (0)