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

DOC: update links to compwa.github.io #244

Merged
merged 2 commits into from
Jan 20, 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
4 changes: 1 addition & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@
[![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/qrules)
[![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/qrules)

This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more
information about how to contribute to the packages, go to
[compwa-org.rtfd.io/develop.html](https://compwa-org.readthedocs.io/en/stable/develop.html)!
This package is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to [compwa.github.io/develop](https://compwa.github.io/develop)!
9 changes: 6 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ def create_constraints_inventory() -> None:
api_github_repo = f"{ORGANIZATION}/{REPO_NAME}"
api_target_substitutions: dict[str, str | tuple[str, str]] = {
"EdgeType": "typing.TypeVar",
"GraphElementProperties": ("obj", "qrules.solving.GraphElementProperties"),
"GraphSettings": ("obj", "qrules.solving.GraphSettings"),
"InitialFacts": ("obj", "qrules.combinatorics.InitialFacts"),
"NewEdgeType": "typing.TypeVar",
"NewNodeType": "typing.TypeVar",
"NodeType": "typing.TypeVar",
Expand Down Expand Up @@ -189,7 +192,7 @@ def create_constraints_inventory() -> None:
"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 @@ -245,7 +248,7 @@ def create_constraints_inventory() -> None:
intersphinx_mapping = {
"ampform": ("https://ampform.readthedocs.io/en/stable", 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),
"constraint": ("https://labix.org/doc/constraint/public", "constraint.inv"),
"graphviz": ("https://graphviz.readthedocs.io/en/stable", None),
"IPython": (f"https://ipython.readthedocs.io/en/{pin('IPython')}", None),
Expand Down Expand Up @@ -274,7 +277,7 @@ def create_constraints_inventory() -> None:
"run_interactive": f"""
```{{margin}}
Run this notebook [on Binder]({BINDER_LINK}) or
{{ref}}`locally on Jupyter Lab <compwa-org:develop:Jupyter Notebooks>` to interactively
{{ref}}`locally on Jupyter Lab <compwa:develop:Jupyter Notebooks>` to interactively
modify the parameters.
```
""",
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ maxdepth: 2
API <api/qrules>
Changelog <https://github.com/ComPWA/qrules/releases>
Upcoming features <https://github.com/ComPWA/qrules/milestones?direction=asc&sort=title&state=open>
Help developing <https://compwa-org.readthedocs.io/en/stable/develop.html>
Help developing <https://compwa.github.io/develop>
```

```{toctree}
Expand All @@ -136,5 +136,5 @@ hidden:
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>
```
18 changes: 9 additions & 9 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ can find on the [`stable`](https://github.com/ComPWA/qrules/tree/stable) branch.

Optionally, you can install the dependencies required for
{doc}`visualizing topologies </usage/visualize>` with the following
{ref}`optional dependency syntax <compwa-org:develop:Optional dependencies>`:
{ref}`optional dependency syntax <compwa:develop:Optional dependencies>`:

```shell
pip install qrules[viz] # installs qrules with graphviz
Expand All @@ -49,13 +49,13 @@ python3 -m pip install git+https://github.com/ComPWA/qrules@main
## Editable installation

It is highly recommend to use the more dynamic
{ref}`'editable installation' <compwa-org:develop:Editable installation>`. This allows
{ref}`'editable installation' <compwa:develop:Editable installation>`. This allows
you to:

- exactly {ref}`pin all dependencies <compwa-org:develop:Pinning dependency versions>`
- exactly {ref}`pin all dependencies <compwa:develop:Pinning dependency versions>`
to a specific version, so that your work is **reproducible**.
- edit the source code of the framework and
{doc}`help improving it <compwa-org:develop>`.
{doc}`help improving it <compwa:develop>`.

For this, you first need to get the source code with [Git](https://git-scm.com):

Expand Down Expand Up @@ -85,11 +85,11 @@ This installs the project in a Conda environment following the definitions in

1. **[Recommended]** Create a virtual environment with
[`venv`](https://docs.python.org/3/library/venv.html) (see
{ref}`here <compwa-org:develop:Virtual environment>`).
{ref}`here <compwa:develop:Virtual environment>`).

2. Install the project as an
{ref}`'editable installation' <compwa-org:develop:Editable installation>` with
{ref}`additional packages <compwa-org:develop:Optional dependencies>` for the
{ref}`'editable installation' <compwa:develop:Editable installation>` with
{ref}`additional packages <compwa:develop:Optional dependencies>` for the
developer and all dependencies pinned through
[constraints files](https://pip.pypa.io/en/stable/user_guide/#constraints-files):

Expand All @@ -101,9 +101,9 @@ This installs the project in a Conda environment following the definitions in

::::

See {ref}`compwa-org:develop:Updating` for how to update the dependencies when new
See {ref}`compwa:develop:Updating` for how to update the dependencies when new
commits come in.

That's all! Have a look at {doc}`/usage` to try out the package. You can also have a
look at {doc}`compwa-org:develop` for tips on how to work with this 'editable' developer
look at {doc}`compwa:develop` for tips on how to work with this 'editable' developer
setup!
2 changes: 1 addition & 1 deletion docs/usage/particle.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As a side note, {mod}`qrules` provides [JSON schemas](https://json-schema.org) ({download}`reaction/particle-validation.json <../../src/qrules/particle-validation.json>`) to validate your particle list files (see also {func}`jsonschema.validators.validate`). If you have installed {mod}`qrules` as an {ref}`compwa-org:develop:Editable installation` and {ref}`use VSCode <develop:Visual Studio code>`, your YAML particle list are checked automatically in the GUI."
"As a side note, {mod}`qrules` provides [JSON schemas](https://json-schema.org) ({download}`reaction/particle-validation.json <../../src/qrules/particle-validation.json>`) to validate your particle list files (see also {func}`jsonschema.validators.validate`). If you have installed {mod}`qrules` as an {ref}`compwa:develop:Editable installation` and {ref}`use VSCode <develop:Visual Studio code>`, your YAML particle list are checked automatically in the GUI."
]
}
],
Expand Down
Loading