Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
ba67f0f
Trying to speed up docs build
john-science Aug 27, 2025
2b7b166
Trying to speed up docs build
john-science Aug 27, 2025
820b7fe
Trying Docker for Docs
john-science Aug 28, 2025
06b2f21
Trying an updated container
john-science Aug 28, 2025
15bb4b3
take 2
john-science Aug 28, 2025
65f1640
take3
john-science Aug 28, 2025
a562606
python3.13 take
john-science Aug 28, 2025
4155a77
installing pip in the dockerfile
john-science Aug 28, 2025
2b82674
We can't update pip?
john-science Aug 28, 2025
3a63327
Not using pip update
john-science Aug 28, 2025
46a9cff
Trying to get docker working - ownership troubles
john-science Aug 28, 2025
eb0bcbb
can i do this without sudo?
john-science Aug 28, 2025
d634b15
why won't it install?
john-science Aug 28, 2025
c665910
Update docs_docker.yaml
john-science Aug 28, 2025
180465c
checking out repo
john-science Aug 28, 2025
ba9f654
typo
john-science Aug 28, 2025
f28ac84
upgrade pip
john-science Aug 28, 2025
532a3ce
trying random stuff
john-science Aug 28, 2025
1488193
we need setuptools?
john-science Aug 28, 2025
860eb05
TESTING pytest
john-science Aug 28, 2025
d1a7ee0
more pytest args
john-science Aug 28, 2025
1d2028c
Update docs_docker.yaml
john-science Aug 29, 2025
f9fd8ba
Is pipe the problem?
john-science Aug 29, 2025
cad1abf
Is BASH redirect the problem?
john-science Aug 29, 2025
6d46d93
Maybe it's one test?
john-science Aug 29, 2025
b383885
Cleanup
john-science Aug 29, 2025
9976403
Trying a new container
john-science Aug 29, 2025
2c22b66
Permissions warfare
john-science Aug 29, 2025
889cec0
wrong dir name
john-science Aug 29, 2025
6f1715c
Try to get the GH CLI working inside docker
john-science Aug 29, 2025
3a43661
Is the GH_TOKEN enough?
john-science Aug 29, 2025
f3e2158
Are the pytest xmls being created?
john-science Aug 29, 2025
3665702
Update docs_docker.yaml
john-science Aug 29, 2025
ad34c96
print later
john-science Aug 29, 2025
4910e41
lets look around
john-science Aug 29, 2025
8a3c909
typo in testing
john-science Aug 29, 2025
e3b2f06
Merge branch 'doc_doc' of https://github.com/terrapower/armi into doc…
john-science Nov 12, 2025
b15454c
Merge branch 'main' into doc_doc
john-science Nov 12, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@ jobs:
uses: actions/setup-python@v2
with:
python-version: 3.13
- name: Update package index
run: sudo apt-get update
- name: Install apt-get libs
run: sudo apt-get -y install texlive-xetex=2021.20220204-1 texlive-latex-base=2021.20220204-1 texlive-fonts-recommended=2021.20220204-1 texlive-latex-extra=2021.20220204-1 texlive-full=2021.20220204-1 pandoc libopenmpi-dev
run: sudo apt-get -y install --fix-missing texlive-xetex=2021.20220204-1 texlive-latex-base=2021.20220204-1 texlive-fonts-recommended=2021.20220204-1 texlive-latex-extra=2021.20220204-1 texlive-full=2021.20220204-1 pandoc libopenmpi-dev
- name: Setup Graphviz
uses: ts-graphviz/setup-graphviz@v2.0.2
- name: Make html/pdf Docs
Expand All @@ -36,14 +34,19 @@ jobs:
run: |
echo "Installing ARMI..."
set -x
pip install -U pip
#pip install -U pip
pip install -e .[memprof,mpi,test,docs]

echo "Run unit tests..."
pytest --junit-xml=test_results.xml -v -n 4 armi > pytest_verbose.log
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=test_results_mpi1.xml armi/tests/test_mpiFeatures.py > pytest_verbose_mpi1.log
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=test_results_mpi2.xml armi/tests/test_mpiParameters.py > pytest_verbose_mpi2.log
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=test_results_mpi3.xml armi/utils/tests/test_directoryChangersMpi.py > pytest_verbose_mpi3.log
pytest --junit-xml=/__w/armi/armi/test_results.xml -v -n 4 armi > pytest_verbose.log
echo "============================================================"
ls
ls > tmp.txt
cat tmp.txt
echo "============================================================"
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=/__w/armi/armi/test_results_mpi1.xml armi/tests/test_mpiFeatures.py > pytest_verbose_mpi1.log
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=/__w/armi/armi/test_results_mpi2.xml armi/tests/test_mpiParameters.py > pytest_verbose_mpi2.log
mpiexec -n 2 --use-hwthread-cpus pytest --junit-xml=/__w/armi/armi/test_results_mpi3.xml armi/utils/tests/test_directoryChangersMpi.py > pytest_verbose_mpi3.log
python doc/.static/cleanup_test_results.py test_results.xml

echo "Git magic so the SCR will build on GitHub Actions..."
Expand Down
89 changes: 89 additions & 0 deletions .github/workflows/docs_docker.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Documentation using Docker

on:
push:
branches:
- main
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-22.04
container: johnscience/armi:v5

# python3.13 -m pytest --junit-xml=test_results.xml -v -n 4 armi > pytest_verbose.log
# mpiexec -n 2 --use-hwthread-cpus python3.13 -m pytest --junit-xml=test_results_mpi1.xml armi/tests/test_mpiFeatures.py > pytest_verbose_mpi1.log
# mpiexec -n 2 --use-hwthread-cpus python3.13 -m pytest --junit-xml=test_results_mpi2.xml armi/tests/test_mpiParameters.py > pytest_verbose_mpi2.log
# mpiexec -n 2 --use-hwthread-cpus python3.13 -m pytest --junit-xml=test_results_mpi3.xml armi/utils/tests/test_directoryChangersMpi.py > pytest_verbose_mpi3.log

# Building and deploying docs is broken on forked repos
if: github.repository == 'terrapower/armi'

steps:
- name: Change Ownership of Directories
run: |
chown -R $(whoami) /github/home
chown -R $(whoami) /__w/armi
- name: Checkout repository
uses: actions/checkout@v2
- name: Make HTML/PDF Docs
continue-on-error: true
env:
GH_TOKEN: ${{ github.token }}
PR_NUMBER: ${{ github.event.number }}
run: |
echo "Installing ARMI..."
set -x
python3.13 -m pip install -U setuptools
python3.13 -m pip install -e .[memprof,mpi,test,docs]

echo "Run unit tests..."
python3.13 -m pytest --junit-xml=test_results.xml -v -n 4 armi/tests/test_runLog.py > pytest_verbose.log
python3.13 -m pytest --junit-xml=test_results.xml -v -n 4 armi/tests/test_apps.py > pytest_verbose_mpi1.log
python3.13 -m pytest --junit-xml=test_results.xml -v -n 4 armi/tests/test_context.py > pytest_verbose_mpi2.log
python3.13 -m pytest --junit-xml=test_results.xml -v -n 4 armi/tests/test_plugins.py > pytest_verbose_mpi3.log
echo "============================================================"
ls
pwd
ls ..
ls /
echo "============================================================"
python3.13 doc/.static/cleanup_test_results.py test_results.xml

echo "Build HTML docs..."
apt-get install -y gh
cd doc
git submodule init
git submodule update
make html

echo "Build PDF docs..."
make latex
cd _build/latex/
latexmk -pdf -f -interaction=nonstopmode ARMI.tex
- name: Deploy
if: github.ref == 'refs/heads/main'
uses: JamesIves/github-pages-deploy-action@v4.6.1
with:
token: ${{ secrets.ACCESS_TOKEN }}
repository-name: ${{ github.repository_owner }}/terrapower.github.io
branch: main
folder: doc/_build/html
target-folder: armi
- name: Archive HTML Docs
if: github.ref != 'refs/heads/main'
uses: actions/upload-artifact@v4
with:
name: html-docs
path: doc/_build/html
retention-days: 5
- name: Archive PDF Docs
uses: actions/upload-artifact@v4
with:
name: pdf-docs
path: doc/_build/latex/ARMI.pdf
retention-days: 5
Loading