Skip to content

Commit 7c91764

Browse files
authored
Cleanups after migration back to beeware.github.io (#754)
1 parent 3d559c1 commit 7c91764

7 files changed

Lines changed: 20 additions & 7 deletions

File tree

.github/workflows/publish.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ env:
2020
jobs:
2121
publish:
2222
name: Build and publish site
23+
if: github.repository == 'beeware/beeware.github.io'
2324
permissions:
2425
contents: write
2526
runs-on: ubuntu-latest

.github/workflows/translate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ env:
1414
jobs:
1515
update-translations:
1616
name: Update Translations
17-
if: github.actor != 'brutusthebee'
17+
if: github.repository == 'beeware/beeware.github.io' && github.actor != 'brutusthebee'
1818
runs-on: ubuntu-latest
1919
steps:
2020
- name: Checkout

.gitignore

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22
_build
33
comment.md
44

5+
# IDEs and oather build artefacts
56
.idea
67
.rumdl_cache
78
.tox
9+
.vscode
810
__pycache__
911
venv*/
10-
.envrc
1112

1213
# macOS Finder artefacts
1314
.DS_Store
15+
16+
# Local credentials
17+
local/
18+
.envrc
19+
.weblate

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

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

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

77
## Getting started
88

docs-redirect/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# docs.beeware.org
2+
3+
This is a microsite that makes `https://docs.beeware.org` a redirection to `https://beeware.org/docs`.
4+
5+
It has an [independent ReadTheDocs.org configuration](https://app.readthedocs.org/projects/docsbeewareorg/).

docs/spelling_wordlist

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ PythonAnywhere
128128
Pythonista
129129
README
130130
READMEs
131+
ReadTheDocs
131132
RIAA
132133
Rackspace
133134
SBOM

tox.ini

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ envlist = docs-lint,docs-all
44
[docs]
55
docs_dir = {tox_root}{/}docs{/}en
66

7-
[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}]
7+
[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}]
88
# Docs are always built on Python 3.13. See also the RTD config.
99
base_python = py313
1010
skip_install = true
1111
passenv =
1212
DEEPL_API_KEY
1313
dependency_groups = docs
1414
commands:
15-
!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
15+
!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
1616
translate : build_pot_translations --exclude=news
1717
translate : build_po_translations ar cs da de es fa fr it ja ko pl pt ru tr zh_CN zh_TW
1818
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:
3333
pt : build_md_translations {posargs} pt
3434
ru : build_md_translations {posargs} ru
3535
tr : build_md_translations {posargs} tr
36-
zh-cn : build_md_translations {posargs} zh_CN
37-
zh-tw : build_md_translations {posargs} zh_TW
36+
zh_CN : build_md_translations {posargs} zh_CN
37+
zh_TW : build_md_translations {posargs} zh_TW
3838
all : build_md_translations {posargs} en ar cs da de es fa fr it ja ko pl pt ru tr zh_CN zh_TW
3939
serve : python -m http.server -d _build/html 8042
4040
live : live_serve_en {posargs} --port=8042

0 commit comments

Comments
 (0)