Skip to content

Commit

Permalink
[doc] updates for latest v1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonRohou committed Jan 28, 2025
1 parent d921723 commit 45e2322
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 12 deletions.
2 changes: 1 addition & 1 deletion doc/doc/conf.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/codac-team/codac/tree/codac2>`_.
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 <https://codac.io/v2>`_.
"""

# GitHub repo
Expand Down
19 changes: 13 additions & 6 deletions doc/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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}
}
@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}
}
2 changes: 1 addition & 1 deletion doc/doc/install/01-installation-full-linux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/doc/install/01-installation-full-macos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Install `Homebrew package manager <https://brew.sh/>`_ 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 `<https://github.com/codac-team/codac/releases/tag/v1.5.6/>`_, 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 `<https://github.com/codac-team/codac/releases/tag/v1.6/>`_, then in ``example`` folder run:

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion doc/doc/install/01-installation-full-windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<https://github.com/codac-team/codac/releases/tag/v1.5.6>`_, 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 `<https://github.com/codac-team/codac/releases/tag/v1.6>`_, 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 `<https://github.com/ENSTABretagneRobotics/VIBES/releases/download/0.2.3/VIBes-0.2.3-win32.exe>`_ before running the project, and check that a tube appears in :ref:`VIBes viewer <sec-installation-graphics>`.

Expand Down
4 changes: 2 additions & 2 deletions doc/doc/install/01-installation-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 45e2322

Please sign in to comment.