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
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Deploy Docs

on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/docs.yml"
workflow_dispatch:

concurrency:
group: docs-deploy
cancel-in-progress: true

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: extractions/setup-just@v4
- uses: astral-sh/setup-uv@v8.2.0
- run: just docs-deploy
13 changes: 0 additions & 13 deletions .readthedocs.yaml

This file was deleted.

5 changes: 5 additions & 0 deletions Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,8 @@ publish:
uv version $GITHUB_REF_NAME
uv build
uv publish --token $PYPI_TOKEN

# Force-pushes built site to gh-pages; CI runs this on push to main.
# Manual invocation from a stale checkout will roll the live site back.
docs-deploy:
uvx --with-requirements docs/requirements.txt mkdocs gh-deploy --force
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ With `lite-bootstrap`, you receive an application with lightweight built-in supp

Those instruments can be bootstrapped for:

- [LiteStar](https://lite-bootstrap.readthedocs.io/integrations/litestar)
- [FastStream](https://lite-bootstrap.readthedocs.io/integrations/faststream)
- [FastAPI](https://lite-bootstrap.readthedocs.io/integrations/fastapi)
- [FastMCP](https://lite-bootstrap.readthedocs.io/integrations/fastmcp)
- [services and scripts without frameworks](https://lite-bootstrap.readthedocs.io/integrations/free)
- [LiteStar](https://lite-bootstrap.modern-python.org/integrations/litestar)
- [FastStream](https://lite-bootstrap.modern-python.org/integrations/faststream)
- [FastAPI](https://lite-bootstrap.modern-python.org/integrations/fastapi)
- [FastMCP](https://lite-bootstrap.modern-python.org/integrations/fastmcp)
- [services and scripts without frameworks](https://lite-bootstrap.modern-python.org/integrations/free)

## Lifecycle constraints

Expand All @@ -47,7 +47,7 @@ Browse the full list of templates and libraries in
[`modern-python`](https://github.com/modern-python) — see the org profile for the
categorized index.

## 📚 [Documentation](https://lite-bootstrap.readthedocs.io)
## 📚 [Documentation](https://lite-bootstrap.modern-python.org)

## 📦 [PyPi](https://pypi.org/project/lite-bootstrap)

Expand Down
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
lite-bootstrap.modern-python.org
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
site_name: lite-bootstrap
site_url: https://lite-bootstrap.modern-python.org
repo_url: https://github.com/modern-python/lite-bootstrap
docs_dir: docs
edit_uri: edit/main/docs/
Expand Down
Loading
Loading