From 48b7f10a4a25c5891242a160a9b9a52fb34f72fc Mon Sep 17 00:00:00 2001 From: Pieter Pas Date: Tue, 17 Dec 2024 20:02:33 +0100 Subject: [PATCH] [Docs] update versions in examples and documentation --- README.md | 14 +++++++------- doxygen/sphinx/source/install/installation.rst | 6 +++--- examples/CMake/Solver/README.md | 4 ++-- examples/CMake/Solver/conanfile.txt | 2 +- python/README.rst | 12 ++++++------ 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index a6bee7080d..8a55e8ea3c 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -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 diff --git a/doxygen/sphinx/source/install/installation.rst b/doxygen/sphinx/source/install/installation.rst index eaefb849bf..4abf9c0b57 100644 --- a/doxygen/sphinx/source/install/installation.rst +++ b/doxygen/sphinx/source/install/installation.rst @@ -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: @@ -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: @@ -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 diff --git a/examples/CMake/Solver/README.md b/examples/CMake/Solver/README.md index a942e25217..28e1b111ed 100644 --- a/examples/CMake/Solver/README.md +++ b/examples/CMake/Solver/README.md @@ -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 ``` @@ -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 diff --git a/examples/CMake/Solver/conanfile.txt b/examples/CMake/Solver/conanfile.txt index e8b8c66de5..6b4ea62681 100644 --- a/examples/CMake/Solver/conanfile.txt +++ b/examples/CMake/Solver/conanfile.txt @@ -1,5 +1,5 @@ [requires] -alpaqa/1.0.0-alpha.19 +alpaqa/1.0.0-alpha.20 [generators] CMakeDeps CMakeToolchain diff --git a/python/README.rst b/python/README.rst index 53dd399eee..85330a5a29 100644 --- a/python/README.rst +++ b/python/README.rst @@ -23,11 +23,11 @@ The solvers in this library solve minimization problems of the following form: Documentation ------------- -- `Documentation (Sphinx) `_ -- `Python examples `_ -- `Documentation (Doxygen) `_ -- `C++ examples `_ -- `Matlab documentation `_ +- `Documentation (Sphinx) `_ +- `Python examples `_ +- `Documentation (Doxygen) `_ +- `C++ examples `_ +- `Matlab documentation `_ Installation ------------ @@ -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 `_. +`installation instructions `_. Publications ------------