Skip to content

Commit

Permalink
[Docs] update versions in examples and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tttapa committed Dec 17, 2024
1 parent 3e5d8ce commit 48b7f10
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![CI Tests: C++](https://github.com/kul-optec/alpaqa/actions/workflows/linux.yml/badge.svg)](https://github.com/kul-optec/alpaqa/actions/workflows/linux.yml)
[![CI Tests: Python](https://github.com/kul-optec/alpaqa/actions/workflows/wheel-short-test.yml/badge.svg)](https://github.com/kul-optec/alpaqa/actions/workflows/wheel-short-test.yml)
[![CI: Matlab](https://github.com/kul-optec/alpaqa/actions/workflows/matlab.yml/badge.svg)](https://github.com/kul-optec/alpaqa/actions/workflows/matlab.yml)
[![Docs](https://img.shields.io/badge/Documentation-1.0.0a19-blue?logo=sphinx)](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/index.html)
[![Docs](https://img.shields.io/badge/Documentation-1.0.0a20-blue?logo=sphinx)](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/index.html)
[![PyPI Downloads](https://img.shields.io/pypi/dm/alpaqa?label=PyPI&logo=python)](https://pypi.org/project/alpaqa)
[![GitHub all releases](https://img.shields.io/github/downloads/kul-optec/alpaqa/total?label=Downloads&logo=cplusplus)](https://github.com/kul-optec/alpaqa/releases)
[![GitHub License](https://img.shields.io/github/license/kul-optec/alpaqa?label=License&logo=gnu)](https://github.com/kul-optec/alpaqa/blob/develop/LICENSE)
Expand Down Expand Up @@ -32,11 +32,11 @@ $$

## Documentation

- [**Documentation** (Sphinx)](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/index.html)
- [**Python examples**](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/examples/index.html)
- [**C++ documentation** (Doxygen)](https://kul-optec.github.io/alpaqa/1.0.0a19/Doxygen/index.html)
- [**C++ examples**](https://kul-optec.github.io/alpaqa/1.0.0a19/Doxygen/examples.html)
- [**Matlab documentation**](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/reference/matlab-api.html)
- [**Documentation** (Sphinx)](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/index.html)
- [**Python examples**](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/examples/index.html)
- [**C++ documentation** (Doxygen)](https://kul-optec.github.io/alpaqa/1.0.0a20/Doxygen/index.html)
- [**C++ examples**](https://kul-optec.github.io/alpaqa/1.0.0a20/Doxygen/examples.html)
- [**Matlab documentation**](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/reference/matlab-api.html)

## Installation

Expand All @@ -47,7 +47,7 @@ python3 -m pip install --upgrade --pre alpaqa
```

For more information, please see the full
[installation instructions](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/install/installation.html).
[installation instructions](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/install/installation.html).

## Publications

Expand Down
6 changes: 3 additions & 3 deletions doxygen/sphinx/source/install/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For Debian-based systems, the .deb packages can be installed using
.. code-block:: sh
sudo apt update
sudo apt install ./libalpaqa*_1.0.0a19_amd64.deb
sudo apt install ./libalpaqa*_1.0.0a20_amd64.deb
Different components are available:

Expand Down Expand Up @@ -70,7 +70,7 @@ Alternatively, the .tar.gz file can be extracted and installed manually.

.. code-block:: sh
sudo tar xzf alpaqa-1.0.0a19-Linux-x86_64.tar.gz -C /usr/local --strip-components=1
sudo tar xzf alpaqa-1.0.0a20-Linux-x86_64.tar.gz -C /usr/local --strip-components=1
This requires glibc 2.17 or later. You may need to install or pre-load the
following additional runtime dependencies:
Expand All @@ -92,7 +92,7 @@ command in the MATLAB command window:

.. code-block:: matlab
unzip(['https://github.com/kul-optec/alpaqa/releases/download/1.0.0a19/alpaqa-matlab-' computer('arch') '.zip'], userpath)
unzip(['https://github.com/kul-optec/alpaqa/releases/download/1.0.0a20/alpaqa-matlab-' computer('arch') '.zip'], userpath)
You need CasADi to be installed as well: https://web.casadi.org/get

Expand Down
4 changes: 2 additions & 2 deletions examples/CMake/Solver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pip install -U conan cmake
Export the alpaqa library to Conan:

```sh
git clone https://github.com/kul-optec/alpaqa --branch=1.0.0a19 --single-branch
git clone https://github.com/kul-optec/alpaqa --branch=1.0.0a20 --single-branch
conan export alpaqa
```

Expand Down Expand Up @@ -135,7 +135,7 @@ cmake --build --preset conan-release -j
```

A complete list of the available components and targets can be found on the
[CMake API Reference](https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/reference/cmake-api.html) page.
[CMake API Reference](https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/reference/cmake-api.html) page.

### Disabling tests

Expand Down
2 changes: 1 addition & 1 deletion examples/CMake/Solver/conanfile.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[requires]
alpaqa/1.0.0-alpha.19
alpaqa/1.0.0-alpha.20
[generators]
CMakeDeps
CMakeToolchain
Expand Down
12 changes: 6 additions & 6 deletions python/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ The solvers in this library solve minimization problems of the following form:
Documentation
-------------

- `Documentation (Sphinx) <https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/index.html>`_
- `Python examples <https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/examples/index.html>`_
- `Documentation (Doxygen) <https://kul-optec.github.io/alpaqa/1.0.0a19/Doxygen/index.html>`_
- `C++ examples <https://kul-optec.github.io/alpaqa/1.0.0a19/Doxygen/examples.html>`_
- `Matlab documentation <https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/reference/matlab-api.html>`_
- `Documentation (Sphinx) <https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/index.html>`_
- `Python examples <https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/examples/index.html>`_
- `Documentation (Doxygen) <https://kul-optec.github.io/alpaqa/1.0.0a20/Doxygen/index.html>`_
- `C++ examples <https://kul-optec.github.io/alpaqa/1.0.0a20/Doxygen/examples.html>`_
- `Matlab documentation <https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/reference/matlab-api.html>`_

Installation
------------
Expand All @@ -39,7 +39,7 @@ The Python interface can be installed directly from PyPI:
python3 -m pip install --upgrade --pre alpaqa
For more information, please see the full
`installation instructions <https://kul-optec.github.io/alpaqa/1.0.0a19/Sphinx/install/installation.html>`_.
`installation instructions <https://kul-optec.github.io/alpaqa/1.0.0a20/Sphinx/install/installation.html>`_.

Publications
------------
Expand Down

0 comments on commit 48b7f10

Please sign in to comment.