Repository navigation
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
soraros
force-pushed
the
modernise-build
branch
2 times, most recently
from
September 29, 2026 11:28
03b145c to
eb19d16
Compare
soraros
marked this pull request as draft
September 29, 2026 13:25
soraros
force-pushed
the
modernise-build
branch
4 times, most recently
from
September 29, 2026 14:03
48ffa29 to
74f3cc1
Compare
soraros
force-pushed
the
modernise-build
branch
from
September 30, 2026 04:34
74f3cc1 to
74669e0
Compare
soraros
force-pushed
the
modernise-build
branch
from
September 30, 2026 04:39
74669e0 to
cb5bd0e
Compare
This branch has not been deployed
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.
Motivation
I opened issue #17 to discuss the motivation for this change, as requested by the contribution guide. The aim is to give students and contributors a consistent path from installation to a working example. A common setup also makes it easier to help someone during installation and gives CI and future automated development the same checks that contributors can run locally.
Changes
The PR remains in two commits, each with a separate purpose:
PatchTest8.pro, builds the distributions, and installs the wheel outside the checkout. The documentation build uses onedocsextra in CI and Read the Docs, generates the API reference with AutoAPI, and uses Furo for responsive navigation. The existing GitHub Pages publication path moves from writing a branch to GitHub's dedicated Pages actions.No
pyfem/source file or example input differs from the currentmain; this PR is not intended to alter numerical results.Verification
uv run --no-sync pytest -qpassed all 200 tests on Python 3.10.uv buildproduced an sdist and wheel. An isolated Python 3.10 installation of the wheel passed import, version, and CLI checks and completedPatchTest8.prooutside the checkout.For local reproduction, the commands are in
CONTRIBUTING.mdanddoc/README.md.Publishing note
After merge, the repository's Settings → Pages → Build and deployment → Source must be set to GitHub Actions. The Pages deployment job runs only on a push to
main; Read the Docs remains the primary documentation site.This contribution was prepared with help from Codex. Thank you for taking the time to read and review it, and for maintaining PyFEM.