Skip to content

Commit

Permalink
DOC: update links to compwa.github.io (#91)
Browse files Browse the repository at this point in the history
* DX: switch to Python 3.9 in developer environment
  • Loading branch information
redeboer authored Jan 20, 2024
1 parent 2fd5b20 commit 0d35ee5
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
tasks:
- init: pyenv local 3.8
- init: pip install -c .constraints/py3.8.txt -e .[dev]
- init: pyenv local 3.9
- init: pip install -c .constraints/py3.9.txt -e .[dev]

github:
prebuilds:
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repos:
- id: check-useless-excludes

- repo: https://github.com/ComPWA/policy
rev: 0.2.0
rev: 0.2.2
hooks:
- id: check-dev-files
args:
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@
"icon_links": [
{
"name": "Common Partial Wave Analysis",
"url": "https://compwa-org.rtfd.io",
"url": "https://compwa.github.io",
"icon": "_static/favicon.ico",
"type": "local",
},
Expand Down Expand Up @@ -162,7 +162,7 @@
"IPython": (f"https://ipython.readthedocs.io/en/{pin('IPython')}", None),
"ampform": (f"https://ampform.readthedocs.io/en/{pin('ampform')}", None),
"attrs": (f"https://www.attrs.org/en/{pin('attrs')}", None),
"compwa-org": ("https://compwa-org.readthedocs.io", None),
"compwa": ("https://compwa.github.io", None),
"graphviz": ("https://graphviz.readthedocs.io/en/stable", None),
"ipywidgets": (f"https://ipywidgets.readthedocs.io/en/{pin('ipywidgets')}", None),
"jax": ("https://jax.readthedocs.io/en/latest", None),
Expand Down
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can substitute `stable` in the above command with `main` or any of the [tags
ampform-dpd @ git+https://github.com/ComPWA/ampform-dpd@main
```

However, we highly recommend using the more dynamic, {ref}`'editable installation' <compwa-org:develop:Editable installation>` instead. This goes as follows:
However, we highly recommend using the more dynamic, {ref}`'editable installation' <compwa:develop:Editable installation>` instead. This goes as follows:

1. Get the source code (see [the Pro Git Book](https://git-scm.com/book/en/v2)):

Expand All @@ -40,15 +40,15 @@ However, we highly recommend using the more dynamic, {ref}`'editable installatio
cd ampform-dpd
```

2. **\[Recommended\]** Create a virtual environment (see {ref}`here <compwa-org:develop:Virtual environment>` or the tip below).
2. **\[Recommended\]** Create a virtual environment (see {ref}`here <compwa:develop:Virtual environment>` or the tip below).

3. Install the project in {ref}`'editable installation' <compwa-org:develop:Editable installation>` with {ref}`additional dependencies <compwa-org:develop:Optional dependencies>` for the developer:
3. Install the project in {ref}`'editable installation' <compwa:develop:Editable installation>` with {ref}`additional dependencies <compwa:develop:Optional dependencies>` for the developer:

```shell
python3 -m pip install -e .[dev]
```

That's all! Have a look at the {doc}`/index` page to try out the package, and see {doc}`compwa-org:develop` for tips on how to work with this 'editable' developer setup!
That's all! Have a look at the {doc}`/index` page to try out the package, and see {doc}`compwa:develop` for tips on how to work with this 'editable' developer setup!
:::{tip}
Expand All @@ -59,7 +59,7 @@ conda env create
conda activate ampform-dpd
```

This way of installing is also safer, because it {ref}`pins all dependencies <compwa-org:develop:Pinning dependency versions>`. Note you can also pin dependencies with `pip`, by running:
This way of installing is also safer, because it {ref}`pins all dependencies <compwa:develop:Pinning dependency versions>`. Note you can also pin dependencies with `pip`, by running:

```shell
python3 -m pip install -e .[dev] -c .constraints/py3.x.txt
Expand Down Expand Up @@ -196,5 +196,5 @@ QRules <https://qrules.readthedocs.io>
AmpForm <https://ampform.readthedocs.io>
TensorWaves <https://tensorwaves.readthedocs.io>
PWA Pages <https://pwa.readthedocs.io>
ComPWA project <https://compwa-org.readthedocs.io>
ComPWA project <https://compwa.github.io>
```
4 changes: 2 additions & 2 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ channels:
- defaults
dependencies:
- graphviz
- python==3.8.*
- python==3.9.*
- pip
- pip:
- -c .constraints/py3.8.txt -e .[dev]
- -c .constraints/py3.9.txt -e .[dev]
variables:
PRETTIER_LEGACY_CLI: "1"
PYTHONHASHSEED: 0

0 comments on commit 0d35ee5

Please sign in to comment.