Skip to content

Introduce build automation for generated docs#75

Open
tuxalp wants to merge 5 commits into
mainfrom
fix-tools-scripts-with-uv
Open

Introduce build automation for generated docs#75
tuxalp wants to merge 5 commits into
mainfrom
fix-tools-scripts-with-uv

Conversation

@tuxalp
Copy link
Copy Markdown
Contributor

@tuxalp tuxalp commented May 20, 2026

Components of the build automation framework:

  • pyproject.toml configured with setuptools (https://setuptools.pypa.io/en/latest/)
  • docs are generated with python -m build (can be run locally)
  • setup.py in the root project acts as the interface for the build (where we can add tools to be run during the build)
  • The build writes all output to a new directory ("site"), excluded from git
  • The new Github Action pages.yaml runs a script tools/build.sh (can also be run/tested locally) which runs the build via python -m build and uploads the generated docs to GitHub Pages

@tuxalp tuxalp requested a review from ue71603 May 20, 2026 09:21
@ue71603 ue71603 moved this from Backlog to In progress in NeTEx realisation guide Switzerland May 20, 2026
Copy link
Copy Markdown
Contributor

@ue71603 ue71603 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is not mergable:

  • You deleted the old workflow (already prior to the PR) ci.yml. This would have shown you a lot about handling the branches.
  • It does not make the toolchain work, but only one element. When I ue build_all.bat two processes break.
  • pages.yaml still starts with an inappropriate comment.
  • already in main branch: the usage of configuration.py broke the toolchain as it was not applied over everything.
  • The readme.md about uv is not really done in the way one should do stuff.How to install, how to load.

So as the PR is incomplete and breaking the toolchain, I don't have a look at this PR again, until it is really finished and documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

2 participants