Skip to content
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
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Please describe the tests that you ran to verify your changes. Provide instructi

# Checklist:

- [ ] I have followed the project [style guide](https://ipc-sim.github.io/ipc-toolkit/style_guide.html)
- [ ] I have followed the project [style guide](https://ipctk.xyz/style_guide.html)
- [ ] My code follows the clang-format style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
Expand Down
12 changes: 11 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,18 @@ jobs:
for version in $(git tag -l); do
echo "Processing $version:"
git checkout $version

# Fix links
grep -rli 'url = {https://ipc-sim.github.io/ipc-toolkit/}' ../* | xargs -i@ sed -i 's/ipc-sim.github.io\/ipc-toolkit\//github.com\/ipc-sim\/ipc-toolkit/g' @
grep -rli 'ipc-sim.github.io/ipc-toolkit' ../* | xargs -i@ sed -i 's/ipc-sim.github.io\/ipc-toolkit/ipctk.xyz/g' @

pip install --force-reinstall -v "ipctk==$version"
sphinx-build source build/html/$version -D html_theme_options.version_dropdown=true
sphinx-build source build/html/$version \
-D html_theme_options.version_dropdown=true \
-D html_theme_options.version_json=https://ipctk.xyz/versions.json

# Discard changes
git reset --hard
done
pip uninstall -y ipctk
git checkout $HEAD
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<p align="center">
<a href="https://ipc-sim.github.io/ipc-toolkit"><img alt="IPC Toolkit" src="docs/source/_static/logo.png" width="80%"></a>
<a href="https://ipctk.xyz"><img alt="IPC Toolkit" src="docs/source/_static/logo.png" width="80%"></a>
</p>

<p align="center">
<a href="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml/badge.svg"></a>
<a href="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml/badge.svg"></a>
<a href="https://ipc-sim.github.io/ipc-toolkit/"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg"></a>
<a href="https://ipctk.xyz"><img src="https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg"></a>
<a href="https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ipc-sim/ipc-toolkit.svg?color=blue"></a>
</p>

Expand Down Expand Up @@ -102,7 +102,7 @@ The following are downloaded when unit tests are enabled (`IPC_TOOLKIT_BUILD_TES

We provide Python bindings for functions in the toolkit using [pybind11](https://github.com/pybind/pybind11).

For more information see the [Python documentation](https://ipc-sim.github.io/ipc-toolkit/python/).
For more information see the [Python documentation](https://ipctk.xyz/python/).

## Contributing

Expand All @@ -123,7 +123,7 @@ If you use the IPC Toolkit in your project, please consider citing our work:
@software{ipc_toolkit,
author = {Zachary Ferguson and others},
title = {{IPC Toolkit}},
url = {https://ipc-sim.github.io/ipc-toolkit/},
url = {https://github.com/ipc-sim/ipc-toolkit},
year = {2020},
}
```
Expand Down
6 changes: 3 additions & 3 deletions docs/PYPI_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ pip install git+https://github.com/ipc-sim/ipc-toolkit

## Help/Documentation

* A tutorial on how to use the toolkit can be found [here](https://ipc-sim.github.io/ipc-toolkit/tutorial/getting_started.html).
* A function reference can be found [here](https://ipc-sim.github.io/ipc-toolkit/python.html).
* A tutorial on how to use the toolkit can be found [here](https://ipctk.xyz/tutorial/getting_started.html).
* A function reference can be found [here](https://ipctk.xyz/python.html).

## Contributing

Expand All @@ -59,7 +59,7 @@ If you use the IPC Toolkit in your project, please consider citing our work:
@software{ipc_toolkit,
author = {Zachary Ferguson and others},
title = {{IPC Toolkit}},
url = {https://ipc-sim.github.io/ipc-toolkit/},
url = {https://github.com/ipc-sim/ipc-toolkit},
year = {2020},
}
```
Expand Down
8 changes: 4 additions & 4 deletions docs/source/_static/versions.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
[{
"version": "https://ipc-sim.github.io/ipc-toolkit",
"version": "https://ipctk.xyz",
"title": "main",
"aliases": ["latest", "head"]
}, {
"version": "https://ipc-sim.github.io/ipc-toolkit/v1.1.1",
"version": "https://ipctk.xyz/v1.1.1",
"title": "v1.1.1",
"aliases": ["stable"]
}, {
"version": "https://ipc-sim.github.io/ipc-toolkit/v1.1.0",
"version": "https://ipctk.xyz/v1.1.0",
"title": "v1.1.0"
}, {
"version": "https://ipc-sim.github.io/ipc-toolkit/v1.0.0",
"version": "https://ipctk.xyz/v1.0.0",
"title": "v1.0.0"
}]
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@
# "github_type": "star",
# "fixed_sidebar": False,
# "page_width": "1200px",
# "canonical_url": "https://ipc-sim.github.io/ipc-toolkit/",
# "canonical_url": "https://ipctk.xyz/",
# }

# Material theme options
Expand All @@ -173,7 +173,7 @@
}
}],

"site_url": "https://ipc-sim.github.io/ipc-toolkit",
"site_url": "https://ipctk.xyz",

# Set the repo location to get a badge with stats
"repo_url": "https://github.com/ipc-sim/ipc-toolkit",
Expand Down Expand Up @@ -202,7 +202,7 @@
"toc_title": "Contents",

"version_dropdown": True,
"version_json": "https://ipc-sim.github.io/ipc-toolkit/versions.json",
"version_json": "https://ipctk.xyz/versions.json",
}

html_title = "IPC Toolkit"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ C++
:target: https://github.com/ipc-sim/ipc-toolkit/actions/workflows/continuous.yml
:alt: Build
.. image:: https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg
:target: https://ipc-sim.github.io/ipc-toolkit/
:target: https://ipctk.xyz/
:alt: Docs
.. image:: https://img.shields.io/github/license/ipc-sim/ipc-toolkit.svg?color=blue
:target: https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ dependencies = ["numpy", "scipy"]
keywords = ["IPC", "simulation", "physics", "science", "reserch"]

[project.urls]
"Homepage" = "https://ipc-sim.github.io/ipc-toolkit/"
"Homepage" = "https://ipctk.xyz"
"Bug Tracker" = "https://github.com/ipc-sim/ipc-toolkit/issues"
"Source Code" = "https://github.com/ipc-sim/ipc-toolkit"

Expand Down
6 changes: 3 additions & 3 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
![PyPI](https://img.shields.io/pypi/v/ipctk?color=brightgreen&label=PyPI&logo=python&logoColor=white)
![PyPI - Downloads](https://img.shields.io/pypi/dm/ipctk?label=PyPI%20Downloads&logo=python&logoColor=white)
[![Python](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml/badge.svg)](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/python.yml)
[![Docs](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg)](https://ipc-sim.github.io/ipc-toolkit/)
[![Docs](https://github.com/ipc-sim/ipc-toolkit/actions/workflows/docs.yml/badge.svg)](https://ipctk.xyz/)
[![License](https://img.shields.io/github/license/ipc-sim/ipc-toolkit.svg?color=blue)](https://github.com/ipc-sim/ipc-toolkit/blob/main/LICENSE)

We provide Python bindings for functions in the toolkit using [pybind11](https://github.com/pybind/pybind11).
Expand Down Expand Up @@ -50,6 +50,6 @@ make -j4

## Help/Documentation

* A tutorial on how to use the toolkit can be found [here](https://ipc-sim.github.io/ipc-toolkit/tutorial/getting_started.html).
* A tutorial on how to use the toolkit can be found [here](https://ipctk.xyz/tutorial/getting_started.html).
* We provide a Jupyter notebook (`python/example.ipynb`) with some simple examples.
* A function reference can be found [here](https://ipc-sim.github.io/ipc-toolkit/python.html).
* A function reference can be found [here](https://ipctk.xyz/python.html).