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 build to fix CI #472

Merged
merged 10 commits into from
Sep 11, 2024
Merged
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/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ jobs:

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
- name: Set up Python 3.12
uses: actions/setup-python@v2
with:
python-version: 3.8
python-version: 3.12
- uses: pre-commit/action@v2.0.0

build:
Expand All @@ -24,10 +24,10 @@ jobs:

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
- name: Set up Python 3.12
uses: actions/setup-python@v2
with:
python-version: 3.8
python-version: 3.12
- name: Install python dependencies
run: |
pip install --upgrade pip
Expand Down
5 changes: 2 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ repos:
rev: '22.6.0'
hooks:
- id: black
language_version: python3.8

- repo: https://github.com/myint/rstcheck
rev: v6.1.0
rev: v6.2.4
hooks:
- id: rstcheck
additional_dependencies:
- sphinx==4.1.2
- sphinx~=8.0.0
6 changes: 5 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
# Required
version: 2

build:
os: "ubuntu-22.04"
tools:
python: "3.12"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
Expand All @@ -16,6 +21,5 @@ formats: []

# Optionally set the version of Python and requirements required to build your docs
python:
version: "3.8"
install:
- requirements: requirements.txt
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ cleannotebooks:

# -W: exit on warning
defaultdoc:
$(SPHINXBUILD) -b html -nW $(ALLSPHINXOPTS) $(BUILDDIR)/html
$(SPHINXBUILD) -b html -T -W --keep-going $(ALLSPHINXOPTS) $(BUILDDIR)/html

all: html latexpdf

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

suppress_warnings = ["misc.highlighting_failure"]

# Links we ignore, because they do not work temporary and we cannot fix it
linkcheck_ignore = ["https://www.big-map.eu/"]


def setup(app):
"""Setup function called by sphinx."""
Expand Down
2 changes: 1 addition & 1 deletion docs/sections/getting_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ AiiDAlab Launch makes it easy to run AiiDA on your own workstation or laptop.
To use AiiDAlab launch you will have to

1. [Install Docker on your workstation or laptop](https://docs.docker.com/get-docker/) and [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/).
2. Install AiiDAlab launch with [pipx](https://pypa.github.io/pipx/installation/) (**recommended**):
2. Install AiiDAlab launch with [pipx](https://pipx.pypa.io/stable/installation/) (**recommended**):

```console
pipx install aiidalab-launch
Expand Down
2 changes: 1 addition & 1 deletion docs/sections/writing_workflows/validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ You can read about the ports and port namespace concepts in the [AiiDA documenta
{{ python }} **The underscore `_` character**

The underscore character has quite a lot interesting use cases in Python!
You can find out more about them [here](https://www.datacamp.com/tutorial/role-underscore-python).
You can find out more about them [here](https://realpython.com/python-double-underscore/).

:::

Expand Down
14 changes: 7 additions & 7 deletions requirements.txt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we pin the versions here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can pin them. Sometimes it is more annoying than helpful to pin verison if a repo changes frequently and needs to update its dependencies. But I guess in this case we only need to update the occasionally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I usually had the same experience so far, and ended up not pinning them usually :D

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
jinja2~=3.0
Sphinx~=4.1
sphinx-book-theme
sphinx-copybutton~=0.4.0
sphinx-panels
sphinx-tabs
myst-nb==0.16.0
jinja2~=3.1.4
Sphinx~=8.0.2
sphinx-book-theme~=1.1.3
sphinx-copybutton~=0.5.2
sphinx-panels~=0.4.1
sphinx-tabs~=3.4.5
myst-nb~=1.1.1
Loading