From 45e2322647c9ff347280272b4850d913f67a9cc6 Mon Sep 17 00:00:00 2001 From: Simon Rohou Date: Tue, 28 Jan 2025 20:56:18 +0100 Subject: [PATCH] [doc] updates for latest v1 release --- doc/doc/conf.py.in | 2 +- doc/doc/index.rst | 19 +++++++++++++------ .../install/01-installation-full-linux.rst | 2 +- .../install/01-installation-full-macos.rst | 2 +- .../install/01-installation-full-windows.rst | 2 +- doc/doc/install/01-installation-python.rst | 4 ++-- 6 files changed, 19 insertions(+), 12 deletions(-) diff --git a/doc/doc/conf.py.in b/doc/doc/conf.py.in index ef8ca2071..bf6f3427a 100644 --- a/doc/doc/conf.py.in +++ b/doc/doc/conf.py.in @@ -65,7 +65,7 @@ rst_prolog = """ :class: right-aligned-note .. seealso:: - This manual refers to Codac v1, but a new v2 implementation is currently in progress... an update of this manual will be available soon. `See more `_. + This manual refers to Codac v1, but a new v2 implementation is currently in progress... an update of this manual will be available soon. `See more `_. """ # GitHub repo diff --git a/doc/doc/index.rst b/doc/doc/index.rst index 6486a01fb..8ecd62592 100644 --- a/doc/doc/index.rst +++ b/doc/doc/index.rst @@ -463,9 +463,16 @@ We suggest the following BibTeX template to cite Codac in scientific discourse: .. code-block:: none - @misc{codac, - author = {Rohou, Simon and Desrochers, Benoit and others}, - year = {2022}, - note = {http://codac.io}, - title = {The {Codac} library -- {C}onstraint-programming for robotics} - } \ No newline at end of file + @article{codac_lib, + title={The {C}odac Library}, + url={https://cyber.bibl.u-szeged.hu/index.php/actcybern/article/view/4388}, + DOI={10.14232/actacyb.302772}, + journal={Acta Cybernetica}, + volume={26}, + number={4}, + series = {Special Issue of {SWIM} 2022}, + author={Rohou, Simon and Desrochers, Benoit and {Le Bars}, Fabrice}, + year={2024}, + month={Mar.}, + pages={871-887} + } \ No newline at end of file diff --git a/doc/doc/install/01-installation-full-linux.rst b/doc/doc/install/01-installation-full-linux.rst index 7f3c19ed6..a25189013 100644 --- a/doc/doc/install/01-installation-full-linux.rst +++ b/doc/doc/install/01-installation-full-linux.rst @@ -10,7 +10,7 @@ Installing Codac v1 on Linux for C++ use Install from package (latest release, for Ubuntu (amd64, arm64), Debian (arm64, armhf) and possibly others) ----------------------------------------------------------------------------------------------------------- -A Debian package is available for the last release 1.5.6 of the library: +A Debian package is available for the last release 1.6 of the library: .. code-block:: bash diff --git a/doc/doc/install/01-installation-full-macos.rst b/doc/doc/install/01-installation-full-macos.rst index b8790c9f9..c052a4bd8 100644 --- a/doc/doc/install/01-installation-full-macos.rst +++ b/doc/doc/install/01-installation-full-macos.rst @@ -18,7 +18,7 @@ Install `Homebrew package manager `_ and build tools: brew install wget autoconf automake libtool brew install --cask cmake -Download and extract *e.g.* ``codac_standalone_arm64_monterey.zip`` (for macOS 12 Monterey on a Mac with Apple silicon (arm64 processor), use ``codac_standalone_x86_64_monterey.zip`` for a Mac with an Intel processor (x86_64 processor), see https://support.apple.com/en-us/116943) from ``_, then in ``example`` folder run: +Download and extract *e.g.* ``codac_standalone_arm64_monterey.zip`` (for macOS 12 Monterey on a Mac with Apple silicon (arm64 processor), use ``codac_standalone_x86_64_monterey.zip`` for a Mac with an Intel processor (x86_64 processor), see https://support.apple.com/en-us/116943) from ``_, then in ``example`` folder run: .. code-block:: bash diff --git a/doc/doc/install/01-installation-full-windows.rst b/doc/doc/install/01-installation-full-windows.rst index f4f3252e9..d2ac53b1b 100644 --- a/doc/doc/install/01-installation-full-windows.rst +++ b/doc/doc/install/01-installation-full-windows.rst @@ -17,7 +17,7 @@ Check https://community.chocolatey.org/packages/codac. .. rubric:: Using Visual Studio -Download and extract *e.g.* ``codac_standalone_x64_vc17.zip`` (for Visual Studio 2022) from ``_, open ``example\CMakelists.txt``, choose ``x64-Release`` configuration in Visual Studio (instead of ``x64-Debug``), double-click on ``main.cpp`` in the Solution Explorer and then click on the green Start button, finally check that "My first tube:Tube [0, 10]" appears. +Download and extract *e.g.* ``codac_standalone_x64_vc17.zip`` (for Visual Studio 2022) from ``_, open ``example\CMakelists.txt``, choose ``x64-Release`` configuration in Visual Studio (instead of ``x64-Debug``), double-click on ``main.cpp`` in the Solution Explorer and then click on the green Start button, finally check that "My first tube:Tube [0, 10]" appears. Optionally, download and run ``_ before running the project, and check that a tube appears in :ref:`VIBes viewer `. diff --git a/doc/doc/install/01-installation-python.rst b/doc/doc/install/01-installation-python.rst index 36de03e19..19d34ab40 100644 --- a/doc/doc/install/01-installation-python.rst +++ b/doc/doc/install/01-installation-python.rst @@ -19,8 +19,8 @@ In case you want to use Codac only with Python, then the installation procedure # You may have to upgrade pip (19.0.0 required at least) pip3 install --upgrade pip - pip3 install codac==1.5.6 - # latest release of Codac v1 is 1.5.6 + pip3 install codac==1.6 + # latest release of Codac v1 is 1.6 .. role:: gbg