Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,6 @@ jobs:
- name: Build documentation from clean sources
run: uv run --frozen --no-sync sphinx-build -W --keep-going -E -a -d "${{ runner.temp }}/doctrees" -b html doc/source "${{ runner.temp }}/generated-docs"

- name: Verify generated documentation is current
run: diff -ru --exclude=.nojekyll "${{ runner.temp }}/generated-docs" docs

test:
name: Test (${{ matrix.os }}, Python ${{ matrix.python-version }})
strategy:
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,6 @@ jobs:
- name: Build documentation from clean sources
run: uv run --frozen --no-sync sphinx-build -W --keep-going -E -a -d "${{ runner.temp }}/doctrees" -b html doc/source "${{ runner.temp }}/generated-docs"

- name: Verify generated documentation is current
run: diff -ru --exclude=.nojekyll "${{ runner.temp }}/generated-docs" docs

- name: Build wheel and source distribution
run: uv build --no-sources

Expand Down
6 changes: 4 additions & 2 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,17 @@ repository or GitHub Actions.
notebook environment. Inspect numerical results and committed output changes
rather than accepting changed output mechanically.
8. Build both the source and published documentation with warnings treated as
errors, verify that generated pages are committed, and check external links:
errors and check external links:

```console
pysnptools_docs_output="$(mktemp -d)"
uv run --frozen --no-sync sphinx-build -W --keep-going -E -a -d /tmp/pysnptools-doctrees -b html doc/source "$pysnptools_docs_output"
diff -ru --exclude=.nojekyll "$pysnptools_docs_output" docs
uv run --frozen --no-sync sphinx-build -W --keep-going -E -a -b linkcheck doc/source doc/build/linkcheck
```

Documentation is deployed from the strict Sphinx build by the Pages artifact
workflow (`docs.yml`). Generated HTML is not checked into Git.

9. Validate every entry in the package's hashdown manifests, including the
packaged tutorial sample files.
10. Build the source distribution and wheel without local source overrides:
Expand Down
4 changes: 0 additions & 4 deletions docs/.buildinfo

This file was deleted.

Empty file removed docs/.nojekyll
Empty file.
Binary file removed docs/_images/example1.png
Binary file not shown.
Binary file removed docs/_images/example2.png
Binary file not shown.
Loading
Loading