[docs] publish MkDocs site from Forgejo Actions
Some checks failed
Publish Docs / publish-docs (push) Has been cancelled
Some checks failed
Publish Docs / publish-docs (push) Has been cancelled
This commit is contained in:
parent
a82eb5858a
commit
f52bf20dd5
4 changed files with 123 additions and 1 deletions
13
README.md
13
README.md
|
|
@ -120,6 +120,16 @@ API and workflow docs are generated from the package docstrings with
|
|||
[MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/),
|
||||
and [mkdocstrings](https://mkdocstrings.github.io/).
|
||||
|
||||
When hosted on a Forgejo instance, the intended setup is:
|
||||
|
||||
- publish the generated site from a dedicated `docs-site` branch
|
||||
- serve that branch from the instance's static-pages host
|
||||
- point the repository's **Wiki** tab at the published docs URL
|
||||
|
||||
The repository contains a Forgejo Actions workflow for publishing the docs
|
||||
branch automatically. Set the repository variable `DOCS_SITE_URL` to the final
|
||||
published URL so MkDocs can generate canonical links correctly.
|
||||
|
||||
Install the docs toolchain with:
|
||||
|
||||
```bash
|
||||
|
|
@ -138,6 +148,9 @@ This produces:
|
|||
- a combined printable single-page HTML site under `site/print_page/`
|
||||
- an optional fully inlined `site/standalone.html` when `htmlark` is available
|
||||
|
||||
The same build output is what the Forgejo Actions workflow publishes to the
|
||||
`docs-site` branch.
|
||||
|
||||
The docs build uses a local MathJax bundle vendored under `docs/assets/`, so
|
||||
the rendered HTML does not rely on external services for equation rendering.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue