Skip to content
Open
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# MkDocs
# Zensical
_build
docs/_build.*.toml
comment.md

# IDEs and oather build artefacts
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the homepage for the [BeeWare project](http://beeware.org).

It is a [MkDocs](https://mkdocs.org)-based site. The site is hosted on GitHub Pages, with PR builds being provided by ReadTheDocs.
It is a [Zensical](https://zensical.org)-based site. The site is hosted on GitHub Pages, with PR builds being provided by ReadTheDocs.

## Getting started

Expand Down
26 changes: 14 additions & 12 deletions docs-redirect/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
version: 2
version: 2

build:
os: "ubuntu-24.04"
tools:
python: "3.12"
jobs:
pre_install:
- python -m pip install --upgrade pip
- python -m pip install --group redirects

mkdocs:
configuration: docs-redirect/mkdocs.yml
build:
os: "ubuntu-24.04"
tools:
python: "3.13"
jobs:
pre_install:
- python -m pip install --upgrade pip
- python -m pip install --group docs-redirect
build:
html:
- python -m zensical build --clean --strict --config-file docs-redirect/zensical.toml
- mkdir -p $READTHEDOCS_OUTPUT
- cp -r docs-redirect/_build/html $READTHEDOCS_OUTPUT/html
15 changes: 0 additions & 15 deletions docs-redirect/mkdocs.yml

This file was deleted.

18 changes: 18 additions & 0 deletions docs-redirect/zensical.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[project]
site_name = "BeeWare"
site_url = "https://docs.beeware.org/"
docs_dir = "en"
site_dir = "_build/html"
# README.md only exists so that the `en` directory exists. Excluding it leaves
# the index page free for the redirect.
exclude_docs = """
README.md
"""

[project.theme]
language = "en"
# Provides the 404 page, which redirects any other URL on the site.
custom_dir = "overrides"

[project.plugins.redirects.redirect_maps]
"index.md" = "https://beeware.org/docs"
Loading
Loading