diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 189b92a6aa..389abfabbb 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -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 diff --git a/.github/workflows/translate.yml b/.github/workflows/translate.yml index dc8da23938..121408e36f 100644 --- a/.github/workflows/translate.yml +++ b/.github/workflows/translate.yml @@ -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 diff --git a/.gitignore b/.gitignore index 9f04371019..eb5d27557d 100644 --- a/.gitignore +++ b/.gitignore @@ -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 diff --git a/README.md b/README.md index 77122a3451..8e25b1ad18 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs-redirect/README.md b/docs-redirect/README.md new file mode 100644 index 0000000000..b656fe8fe7 --- /dev/null +++ b/docs-redirect/README.md @@ -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/). diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index b8090865df..d8bebae0b5 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -128,6 +128,7 @@ PythonAnywhere Pythonista README READMEs +ReadTheDocs RIAA Rackspace SBOM diff --git a/tox.ini b/tox.ini index e7c0d77fca..aee0df47fe 100644 --- a/tox.ini +++ b/tox.ini @@ -4,7 +4,7 @@ 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 @@ -12,7 +12,7 @@ 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 @@ -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