Skip to content

Commit fe9dd31

Browse files
authored
Merge pull request #271 from SimonRohou/codac2_dev
Preparing SWIM tuto
2 parents f4c09a6 + fc41d96 commit fe9dd31

32 files changed

Lines changed: 1705 additions & 12 deletions

doc/manual/_static/css/custom.css

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,4 +150,13 @@ dl.cpp:not(dl.cpp dl.cpp) { /* for displaying a border on doxygen blocks */
150150

151151
a .download:before {
152152
content: "⬇️ ";
153+
}
154+
155+
.toggle-hidden .sphinx-tabs-panel {
156+
background-color: #AAFFBF;
157+
}
158+
159+
.toggle-hidden .sphinx-tabs-panel, .toggle-hidden [aria-selected="true"] {
160+
background-color: #AAFFBF;
161+
border-bottom: 1px solid #AAFFBF;
153162
}

doc/manual/conf.py.in

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,5 +99,6 @@ breathe_projects = {
9999
"codac": "../api/xml"
100100
}
101101

102-
togglebutton_hint = "<strong style=\"color: #009945;\">Reveal the solution.</strong>"
103-
togglebutton_hint_hide = "Hide the solution"
102+
#togglebutton_hint = "<strong style=\"color: #009945;\">Reveal the solution.</strong>"
103+
togglebutton_hint = "Reveal the solution."
104+
togglebutton_hint_hide = "Hide the solution."

doc/manual/manual/installation/index.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
Installation guide
44
==================
55

6-
Main authors: `Fabrice Le Bars <https://www.ensta-bretagne.fr/lebars/>`_, `Simon Rohou <https://www.simon-rohou.fr/research/>`_
7-
86
Codac is available in both C++20 and Python3, as well as MATLAB `through its Python interface <https://fr.mathworks.com/help/matlab/matlab_external/install-supported-python-implementation.html>`_.
97

108
.. toctree::

doc/manual/manual/installation/matlab.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Since 2019, MATLAB allows you to import Python packages into its environment. Co
1414
.. code-block:: bash
1515
1616
pip install codac4matlab --pre
17+
# Option --pre has to be set because Codac v2 is only available in pre-release
1718
1819
Once Codac is installed, you can use it in your MATLAB scripts using the following import command:
1920

doc/manual/manual/installation/python.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ Python installation
55

66
Main authors: `Fabrice Le Bars <https://www.ensta-bretagne.fr/lebars/>`_, `Simon Rohou <https://www.simon-rohou.fr/research/>`_
77

8-
.. error::
9-
10-
Some of the following instructions may not be valid at the moment: Codac v2 is not yet fully available. To get Codac v2 in Python, please see how to :ref:`compile your own binaries locally on your machine <sec-dev-info-binding>`.
11-
128
In case you want to use Codac only with Python, then the installation procedure is simply:
139

1410
1. **Dependencies**: Ensure you have a supported version of Python (>=3.6).
@@ -17,6 +13,7 @@ In case you want to use Codac only with Python, then the installation procedure
1713
.. code-block:: bash
1814
1915
pip install codac --pre
16+
# Option --pre has to be set because Codac v2 is only available in pre-release
2017
2118
2219
You can also update and test your Codac Python package.
@@ -25,6 +22,7 @@ You can also update and test your Codac Python package.
2522
.. code-block:: bash
2623
2724
pip install codac --upgrade --pre
25+
# Option --pre has to be set because Codac v2 is only available in pre-release
2826
2927
3028
* **Testing the installation**: In order to verify that your installation is working properly in Python, you can run:

doc/manual/manual/visualization/vibes.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
The VIBes viewer
44
================
55

6-
Main author: `Simon Rohou <http://simon-rohou.fr/research>`_
7-
86
One of the graphical outputs supported in Codac is `the VIBes viewer <https://enstabretagnerobotics.github.io/VIBES/>`_: a visualization system that aims at providing people working with intervals a way to display results (boxes, pavings), without worrying about GUI programming.
97

108
Installation
14.6 KB
Loading
39.3 KB
Loading
88.8 KB
Loading
30 KB
Loading

0 commit comments

Comments
 (0)