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
1 change: 1 addition & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ env:
jobs:
publish:
name: Build and publish site
if: github.repository == 'beeware/beeware.github.io'
permissions:
contents: write
runs-on: ubuntu-latest
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/translate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ env:
jobs:
update-translations:
name: Update Translations
if: github.actor != 'brutusthebee'
if: github.repository == 'beeware/beeware.github.io' && github.actor != 'brutusthebee'
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down
8 changes: 7 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,18 @@
_build
comment.md

# IDEs and oather build artefacts
.idea
.rumdl_cache
.tox
.vscode
__pycache__
venv*/
.envrc

# macOS Finder artefacts
.DS_Store

# Local credentials
local/
.envrc
.weblate
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.
It is a [MkDocs](https://mkdocs.org)-based site. The site is hosted on GitHub Pages, with PR builds being provided by ReadTheDocs.

## Getting started

Expand Down
5 changes: 5 additions & 0 deletions docs-redirect/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# docs.beeware.org

This is a microsite that makes `https://docs.beeware.org` a redirection to `https://beeware.org/docs`.

It has an [independent ReadTheDocs.org configuration](https://app.readthedocs.org/projects/docsbeewareorg/).
1 change: 1 addition & 0 deletions docs/spelling_wordlist
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ PythonAnywhere
Pythonista
README
READMEs
ReadTheDocs
RIAA
Rackspace
SBOM
Expand Down
8 changes: 4 additions & 4 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ envlist = docs-lint,docs-all
[docs]
docs_dir = {tox_root}{/}docs{/}en

[testenv:docs{,-translate,-lint,-en,-ar,-cs,-da,-de,-es,-fa,-fr,-it,-ja,-ko,-pl,-pt,-ru,-tr,-zh-cn,-zh-tw,-all,-serve,-live}]
[testenv:docs{,-translate,-lint,-en,-ar,-cs,-da,-de,-es,-fa,-fr,-it,-ja,-ko,-pl,-pt,-ru,-tr,-zh_CN,-zh_TW,-all,-serve,-live}]
# Docs are always built on Python 3.13. See also the RTD config.
base_python = py313
skip_install = true
passenv =
DEEPL_API_KEY
dependency_groups = docs
commands:
!translate-!lint-!en-!ar-!cs-!da-!de-!es-!fa-!fr-!it-!ja-!ko-!pl-!pt-!ru-!tr-!zh-cn-!zh-tw-!all-!serve-!live : build_md_translations {posargs} en
!translate-!lint-!en-!ar-!cs-!da-!de-!es-!fa-!fr-!it-!ja-!ko-!pl-!pt-!ru-!tr-!zh_CN-!zh_TW-!all-!serve-!live : build_md_translations {posargs} en
translate : build_pot_translations --exclude=news
translate : build_po_translations ar cs da de es fa fr it ja ko pl pt ru tr zh_CN zh_TW
translate : update_machine_translations --soft-fail ar cs da de es fa fr it ja ko pl pt ru tr zh_CN zh_TW
Expand All @@ -33,8 +33,8 @@ commands:
pt : build_md_translations {posargs} pt
ru : build_md_translations {posargs} ru
tr : build_md_translations {posargs} tr
zh-cn : build_md_translations {posargs} zh_CN
zh-tw : build_md_translations {posargs} zh_TW
zh_CN : build_md_translations {posargs} zh_CN
zh_TW : build_md_translations {posargs} zh_TW
all : build_md_translations {posargs} en ar cs da de es fa fr it ja ko pl pt ru tr zh_CN zh_TW
serve : python -m http.server -d _build/html 8042
live : live_serve_en {posargs} --port=8042