From e6af4bf9de394d0bad403bc019c846b5d7a8210f Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 13:55:24 +0100 Subject: [PATCH 1/2] DOC: update links to compwa.github.io --- CONTRIBUTING.md | 4 +--- docs/conf.py | 6 +++--- docs/index.md | 4 ++-- docs/install.md | 18 +++++++++--------- docs/usage/particle.ipynb | 2 +- 5 files changed, 16 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c848b47..d514fb3e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)! diff --git a/docs/conf.py b/docs/conf.py index 887088fb..b463f323 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -189,7 +189,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", }, @@ -245,7 +245,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), @@ -274,7 +274,7 @@ def create_constraints_inventory() -> None: "run_interactive": f""" ```{{margin}} Run this notebook [on Binder]({BINDER_LINK}) or -{{ref}}`locally on Jupyter Lab ` to interactively +{{ref}}`locally on Jupyter Lab ` to interactively modify the parameters. ``` """, diff --git a/docs/index.md b/docs/index.md index 5cb467f9..40154494 100644 --- a/docs/index.md +++ b/docs/index.md @@ -125,7 +125,7 @@ maxdepth: 2 API Changelog Upcoming features -Help developing +Help developing ``` ```{toctree} @@ -136,5 +136,5 @@ hidden: AmpForm TensorWaves PWA Pages -ComPWA project +ComPWA project ``` diff --git a/docs/install.md b/docs/install.md index f5a8a186..41d991f8 100644 --- a/docs/install.md +++ b/docs/install.md @@ -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 ` with the following -{ref}`optional dependency syntax `: +{ref}`optional dependency syntax `: ```shell pip install qrules[viz] # installs qrules with graphviz @@ -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' `. This allows +{ref}`'editable installation' `. This allows you to: -- exactly {ref}`pin all dependencies ` +- exactly {ref}`pin all dependencies ` to a specific version, so that your work is **reproducible**. - edit the source code of the framework and - {doc}`help improving it `. + {doc}`help improving it `. For this, you first need to get the source code with [Git](https://git-scm.com): @@ -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 `). + {ref}`here `). 2. Install the project as an - {ref}`'editable installation' ` with - {ref}`additional packages ` for the + {ref}`'editable installation' ` with + {ref}`additional packages ` for the developer and all dependencies pinned through [constraints files](https://pip.pypa.io/en/stable/user_guide/#constraints-files): @@ -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! diff --git a/docs/usage/particle.ipynb b/docs/usage/particle.ipynb index 4ca9059f..14a62c42 100644 --- a/docs/usage/particle.ipynb +++ b/docs/usage/particle.ipynb @@ -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 `, 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 `, your YAML particle list are checked automatically in the GUI." ] } ], From 04d9e916fd1409752a94a9c89ca580f4791c9f7e Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 14:02:46 +0100 Subject: [PATCH 2/2] FIX: relink intersphinx objects --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index b463f323..fb538412 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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",