Repository navigation
Remove the unused Read the Docs build config - #28
Merged
Merged
Conversation
The Read the Docs project at abtem.readthedocs.io was built from this repository, not from abTEM/abTEM as its stored repository URL suggests (that field still reads jacobjma/abTEM, a stale value from 2020). Its last build was on 2024-04-26 from commit 418d36f, using exactly this file's recipe: `jupyter-book config sphinx docs/` plus docs/requirements.txt. Builds stopped because the only Read the Docs webhook lives on abTEM/abTEM, where it now fails with HTTP 400; this repository has no webhook at all. The result is a frozen April-2024 snapshot of the same Jupyter Book that is published, current, at abtem.github.io/doc. Documentation is published by .github/workflows/deploy-book.yml to gh-pages on release or manual dispatch, so this config is dead weight. Incoming links to abtem.readthedocs.io are preserved by a redirect configured on the Read the Docs project itself rather than here. No documentation content references abtem.readthedocs.io, so nothing else needs updating. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
GHzytp
pushed a commit
to GHzytp/abTEM
that referenced
this pull request
Sep 22, 2026
This repository still carried a .readthedocs.yml pointing at docs/source/conf.py and docs/doc_requirements.txt, but it has had no docs/ directory since 2fbc17a ("Remove unused documentation files", 2024-05-03). Documentation moved to abTEM/doc, created 2022-07-27, and is published at abtem.github.io/doc. The config was already inert before that: the Read the Docs project at abtem.readthedocs.io was built from abTEM/doc, not from here, despite its stored repository URL still reading jacobjma/abTEM. Its last build, on 2024-04-26, used abTEM/doc commit 418d36f and that repository's jupyter-book recipe. The file here would not have worked in any case, since python.version was dropped from v2 of the Read the Docs schema. Also repoints a comment in test/test_ionization.py from the frozen Read the Docs copy of the core-loss tutorial to its live equivalent on abtem.github.io, which serves the current page. The companion removal on the documentation side is abTEM/doc#28. The Read the Docs webhook still registered on this repository is failing with HTTP 400 and needs deleting in the repository settings, which no commit can do. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
abtem.readthedocs.iois a frozen April-2024 snapshot that has been quietly shadowing the real documentation at abtem.github.io/doc. This removes the build config that fed it.Where the Read the Docs site actually came from
It was built from this repository, which is not obvious from the Read the Docs side — the project's stored repository URL still reads
https://github.com/jacobjma/abTEM.git, a stale value from when the project was created in 2020 (it now redirects toabTEM/abTEM).Confirmed via the Read the Docs public API:
418d36f— a commit that exists inabTEM/docand not inabTEM/abTEM.jupyter-book config sphinx docs/withdocs/requirements.txt, i.e. exactly the recipe in.readthedocs.ymlhere.235df3fb,4fc312c7) are likewiseabTEM/doccommits only.Why it went stale
The only Read the Docs webhook sits on
abTEM/abTEM(readthedocs.org/api/v2/webhook/abtem/129424/) and is currently failing with HTTP 400.abTEM/dochas no webhook at all, so pushes here never triggered a rebuild. The April 2024 builds look hand-triggered from the dashboard — seven builds in ten minutes, six failing then one succeeding.Why removing this is safe
Documentation is published by
.github/workflows/deploy-book.ymltogh-pageson release or manual dispatch. That path is untouched. Read the Docs has not built since April 2024 and continues to serve its last successful build regardless, so nothing breaks at merge time.Incoming links to
abtem.readthedocs.io— of which there are a few years' worth in papers and citations — are preserved by a redirect configured on the Read the Docs project itself (/$rest→https://abtem.github.io/doc/), which is being set up separately by @TomaSusi. That is deliberately kept on the Read the Docs side rather than in this repo.Scope
I grepped the whole repository: every remaining
readthedocsreference points at a third-party project's docs (Black, blackdoc, hypothesis, ipycytoscape, zarr, numpydoc, PyFFTW, Py4DSTEM). Nothing here links toabtem.readthedocs.io, so no content changes were needed.Two related leftovers in
abTEM/abTEMare not addressed here and would need their own PR:abTEM/abTEM/.readthedocs.yml— points atdocs/source/conf.py, but that repo has nodocs/directory at all any more.test/test_ionization.py:4— a comment linking toabtem.readthedocs.io/en/latest/user_guide/tutorials/core_loss.html; the live equivalent isabtem.github.io/doc/user_guide/tutorials/core_loss.html.The stale webhook on
abTEM/abTEMalso still needs deleting, which is a repository settings change rather than anything a PR can carry.🤖 Generated with Claude Code