Skip to content

Generate Gihub Pages with Github Actions #26

Open
bamthomas wants to merge 10 commits intoBoavizta:mainfrom
bamthomas:main
Open

Generate Gihub Pages with Github Actions #26
bamthomas wants to merge 10 commits intoBoavizta:mainfrom
bamthomas:main

Conversation

@bamthomas
Copy link
Copy Markdown

@bamthomas bamthomas commented Apr 8, 2026

This PR is for generating a GH pages web site with the models.

It uses mkdocs with a slightly updated mkdocs-json-schema-plugin.

You can see what it's like on the forked repo : https://bamthomas.github.io/BoAmps/

The following changes have been made:

  1. add a pyproject.toml to use python
  2. add doc/mkdocs.yml that is describing how to make the site to mkdocs
  3. add doc/gen_pages.py that will reuse resources and README.md
  4. add doc/docs/model templates files
  5. finally add the github workflow to generate GH pages

If you merge it you will have to change

site_url: https://bamthomas.github.io/BoAmps/

in mkdocs.yml to https://boavizta.github.io/boamps

It is possible eventually to configure a more fancy url like https://boamps.boavizta.org.

TODO: there is a little bug in the model generated pages that are not folding/unfolding.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant