Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

repair documentation build #77

Merged
merged 2 commits into from
Jun 16, 2023
Merged

repair documentation build #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14ca38a
restore gp-pages branch usage
gilesknap Jun 16, 2023
05f2205
add a note on builder and template macro naming for args
gilesknap Jun 16, 2023
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
26 changes: 9 additions & 17 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ jobs:
docs:
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Avoid git conflicts when tag and branch pushed at same time
if: startsWith(github.ref, 'refs/tags')
Expand Down Expand Up @@ -48,15 +43,12 @@ jobs:
- name: Write switcher.json
run: python .github/pages/make_switcher.py --add $DOCS_VERSION ${{ github.repository }} .github/pages/switcher.json

- name: Setup Pages
uses: actions/configure-pages@v3

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v1.0.8
with:
path: .github/pages

- name: Publish docs to GitHub Pages
- name: Publish Docs to gh-pages
if: github.event_name == 'push' && github.actor != 'dependabot[bot]'
id: deployment
uses: actions/deploy-pages@v2.0.1
# We pin to the SHA, not the tag, for security reasons.
# https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 # v3.9.3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: .github/pages
keep_files: true
11 changes: 11 additions & 0 deletions docs/user/reference/naming.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ Args
Every Arg also has a name and these should be snake_case as they represent
class properties in Python.

HOWEVER: where these arguments refer to a database template macro, the original
name should be used. This means that no changes are required in the templates
in order to support the include_args feature.

ADDITIONAL: because the above caveat breaks the naming convention. We will
maintain the historical naming from builder.py where support module has this
historical support.

SUMMARY: only new modules will use the snake_case naming convention. Others
will use the historical adhoc naming conventions.

Functions
---------

Expand Down