Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

update GHA and run linkcheck #209

Open
wants to merge 4 commits into
base: source
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions .github/workflows/check_sphinx_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@ jobs:
steps:
# https://github.com/actions/checkout
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
submodules: true

- name: Install Conda environment from environment.yml
uses: mamba-org/provision-with-micromamba@v11
uses: mamba-org/provision-with-micromamba@v13

- name: Build documentation
shell: bash -l {0}
run: |
make html
make clean html linkcheck

# workaround https://github.com/actions/upload-artifact/issues/38
- name: tarball
run: tar czf site.tar.gz ./_build/html/

# https://github.com/actions/upload-artifact
- name: Upload Website artifact
uses: actions/upload-artifact@v1
uses: actions/upload-artifact@v3
with:
name: Website
path: site.tar.gz
8 changes: 4 additions & 4 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
submodules: true

- name: Install Conda environment from environment.yml
uses: mamba-org/provision-with-micromamba@v11
uses: mamba-org/provision-with-micromamba@v13

- name: Build documentation
shell: bash -l {0}
run: |
make html
make clean html linkcheck

- name: Deploy
uses: JamesIves/github-pages-deploy-action@3.7.1
uses: JamesIves/github-pages-deploy-action@v4.4.1
if: github.ref == 'refs/heads/source' && github.repository == 'oceanhackweek/oceanhackweek.github.io'
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
4 changes: 2 additions & 2 deletions _InstructionSiteUpdates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Editing OHW web site content and layout

The OceanHackweek web site uses [Sphinx](https://www.sphinx-doc.org/en/master/) with the [PyData theme](https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html) and [Ablog](https://ablog.readthedocs.io/en/latest/) for adding posts.
The OceanHackweek web site uses [Sphinx](https://www.sphinx-doc.org/en/master/) with the [PyData theme](https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html) and [Ablog](https://ablog.readthedocs.io/) for adding posts.

For quick changes to single pages, you can make edits directly via Github, or to make deeper changes you can work locally.

Expand Down Expand Up @@ -90,7 +90,7 @@ posts

Like pages, posts can be written as ReStructured Text, Markdown, or Jupyter notebooks. To be treated as a post, they need to be within the `posts/` directory, and have a selection of metadata.

The location and structure of the metadata varies depending on filetype. For a full list of the options, see the [ABlog](https://ablog.readthedocs.io/en/latest/manual/posting-and-listing/) documentation.
The location and structure of the metadata varies depending on filetype. For a full list of the options, see the [ABlog](https://ablog.readthedocs.io/manual/posting-and-listing/) documentation.

#### Markdown

Expand Down
6 changes: 6 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,3 +148,9 @@

def setup(app):
app.add_css_file("custom.css")


linkcheck_ignore = [
"http://127.0.0.1:8000/",
"https://github.com/myghusername/ohw21-proj-ProjectName",
]
2 changes: 1 addition & 1 deletion resources/prep/conda.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ You can temporarily add packages to your hub, via Jupyter cell magic, `%pip inst
:::{admonition} pip install trouble
:class: danger

For those who know their way around Jupyter, you may be tempted to `!pip install <list-of-packages>`. This can leave your environment in an inconsistent state, which may prevent your server from starting (and will require some heavy duty assistance from `@help-infrastructure` to debug). More information is [available here.](https://pilot.2i2c.org/en/latest/admin/howto/environment.html#temporarily-install-packages-for-a-session)
For those who know their way around Jupyter, you may be tempted to `!pip install <list-of-packages>`. This can leave your environment in an inconsistent state, which may prevent your server from starting (and will require some heavy duty assistance from `@help-infrastructure` to debug). More information is [available here.](https://docs.2i2c.org/en/latest/admin/howto/environment/index.html#temporarily-install-packages-for-a-session)

:::

Expand Down