Repository navigation
Retire the out-of-date Read the Docs site - #167
Merged
ajnonaka merged 1 commit intoNov 10, 2026
Merged
Conversation
ajnonaka
marked this pull request as ready for review
November 10, 2026 17:20
ajnonaka
merged commit Nov 10, 2026
b2fb604
into
AMReX-Microelectronics:development
15 checks passed
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
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.
Retire the out-of-date Read the Docs site
The docs at https://artemis-em.readthedocs.io were inherited from WarpX and haven't been
maintained. ARTEMIS documentation now lives at https://amrex-microelectronics.github.io/.
This PR turns the Read the Docs site into a single page that redirects there.
Changes
Docs/source/(install, usage, theory,developers, data analysis, maintenance, LaTeX theory sources, images, bib files, etc.),
the Doxygen setup (
Docs/Doxyfile,Docs/Doxygen/main.dox),Docs/spack.yaml, andDocs/README.md..github/workflows/source.ymland itsscript
.github/workflows/source/doxygen. Both referred to the deletedDocs/Doxyfile.Docs/source/index.rst: now a single "documentation has moved" page with anautomatic redirect (
<meta http-equiv="refresh">) and a link to the new site.Docs/source/conf.py: replaced with a minimal config (built-inalabastertheme,no extensions, no Doxygen/breathe, no downloads at build time). It builds only
index.rst.Docs/requirements.txt: reduced tosphinx>=7.Docs/Makefile: replaced the WarpX Makefile (Doxygen, LaTeX and Python buildtargets) with the standard minimal Sphinx Makefile.
.readthedocs.yml: same build setup, with the WarpX header andhtmlzipoutput removed.Testing
cd Docs && pip install -r requirements.txt && make htmlbuilds with no warnings. Theoutput is a single
build/html/index.htmlthat redirects tohttps://amrex-microelectronics.github.io/.
Notes
Docs/.Versions) so they stop serving the old pages.