Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add Github workflow: "Pull Request Docs Check" #2499

Closed
wants to merge 32 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
662472a
Add GH workflow: "Pull Request Docs Check"
samsrabin Apr 29, 2024
0fa782d
Update docs-folder.
samsrabin Apr 29, 2024
003cd20
Add requirements.txt.
samsrabin Apr 29, 2024
a40ec60
Add pre-build-command and build-command.
samsrabin Apr 29, 2024
349e0a1
Add sphinx_rtd_theme to requirements.
samsrabin Apr 29, 2024
e5caf17
Make sphinx throw nitpicky errors instead of warning.
samsrabin Apr 29, 2024
ffe0947
Remove docs references to PTCLM.
samsrabin Apr 29, 2024
5008060
Remove ref to missing figure ndown_ctsm_diagram.svg.
samsrabin Apr 29, 2024
63a73ef
Make pr-docs-check run in escomp:base Docker container.
samsrabin Apr 29, 2024
4f362e0
Trying to get pr-docs-check to work in container.
samsrabin Apr 29, 2024
8b8657d
Set docs-folder to just "doc".
samsrabin Apr 29, 2024
7873afd
Add doc/requirements.txt, with just sphinx_rtd_theme.
samsrabin Apr 29, 2024
fa38d72
Add docutils>=0.19 to requirements.txt.
samsrabin Apr 29, 2024
9acd01b
make now fails on nitpicky warnings.
samsrabin Apr 29, 2024
da177a8
Change build-command from "make html" to "make".
samsrabin Apr 29, 2024
43dec3c
Revert "Change build-command from "make html" to "make"."
samsrabin Apr 29, 2024
9476fe7
Try running pr-docs-check on CentOS instead of Ubuntu.
samsrabin Apr 29, 2024
0cfefbb
Revert "Try running pr-docs-check on CentOS instead of Ubuntu."
samsrabin Apr 29, 2024
cf15c11
Resolve "invalid language code" warning.
samsrabin Apr 30, 2024
cf57f65
Update intersphinx_mapping to new format.
samsrabin Apr 30, 2024
499651c
pr-docs-check now runs raw; added new pr-docs-check-container.
samsrabin Apr 30, 2024
c0a5b29
Call "make fetch-images" from doc/.
samsrabin Apr 30, 2024
9e97967
Add pr-docs-check-container-raw.yml.
samsrabin Apr 30, 2024
b1c1aca
Remove "git lfs install" step rom pr-docs-check-container-raw.
samsrabin Apr 30, 2024
c58699b
Add troubleshooting output to pr-docs-check-container-raw.
samsrabin Apr 30, 2024
92e8cba
Add pr-docs-check-container-ssr action.
samsrabin Apr 30, 2024
7326b43
pr-docs-check-container-ssr: Skip "git lfs install" step.
samsrabin Apr 30, 2024
a5d155f
Revert pr-docs-check-container-ssr; add pr-docs-check-ssr.
samsrabin Apr 30, 2024
7e72de8
Delete all requirements.txt in doc/.
samsrabin Apr 30, 2024
af4abb2
pr-docs-check-ssr: Provide full path to build dir. Works!
samsrabin May 1, 2024
33f9e9d
Delete now-unneeded workflow experiments.
samsrabin May 1, 2024
b1c328a
Rename remaining workflow.
samsrabin May 1, 2024
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
Prev Previous commit
Next Next commit
Make sphinx throw nitpicky errors instead of warning.
samsrabin committed Apr 29, 2024
commit e5caf1706fa75282eac8ae49bb6135c0d38f4def
2 changes: 1 addition & 1 deletion .github/workflows/pr-docs-check.yml
Original file line number Diff line number Diff line change
@@ -11,4 +11,4 @@ jobs:
with:
docs-folder: "doc/source"
pre-build-command: "git lfs install && git lfs pull --exclude='' --include=''"
build-command: "sphinx-build -b html . _build"
build-command: "sphinx-build -W --keep-going -n -b html . _build"
Loading