diff --git a/.github/workflows/style.yml b/.github/workflows/style.yml new file mode 100644 index 0000000..ab9fc31 --- /dev/null +++ b/.github/workflows/style.yml @@ -0,0 +1,16 @@ +# The mechanical house-style rules: SPDX header, no Sphinx roles in +# docstrings, no link to the .github repo from a page, no README badges or +# status banner. Pull requests check the changed files; a manual run checks +# every file. Paths that aren't ours go in .style-exclude. +name: Style + +on: + pull_request: + workflow_dispatch: + +permissions: + contents: read + +jobs: + style: + uses: PyDevices/.github/.github/workflows/reusable-style-check.yml@publishing-v20 diff --git a/docs/guides/regenerate-the-pages.md b/docs/guides/regenerate-the-pages.md index cfc43f6..aeaee80 100644 --- a/docs/guides/regenerate-the-pages.md +++ b/docs/guides/regenerate-the-pages.md @@ -9,10 +9,10 @@ rarely. ## Set up the folders The generator finds its siblings by folder name, one level above itself. Put -the `.github` repository in a folder called `dotgithub`: +the `.github` repository in a folder called `dotgithub`, next to a clone of this +one: ```bash -git clone https://github.com/PyDevices/.github dotgithub git clone https://github.com/PyDevices/PyDevices.github.io ```