Skip to content

Commit 104b840

Browse files
committed
slight update of the docu
1 parent 77e569a commit 104b840

File tree

8 files changed

+12
-26
lines changed

8 files changed

+12
-26
lines changed

ct_doc/doc/ct_doc.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ct
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v2.3
41+
PROJECT_NUMBER = v3.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

ct_doc/doc/developer_info.dox

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@ to align the development with ongoing activities.
1010
\section Code Formatting
1111
We support clang-format and provide a style template to automatically format the source code.
1212
Please refer to the clang-format style sheet in the package root directory for our conventions.
13-
Or simply rely on clang-format to do the formatting for you.
14-
15-
Note for developers using the *Eclipse IDE*: you can conveniently integrate clang-format (and our .clang-format
16-
configuration file) in your project using the "CppStyle" plugin (see http://www.cppstyle.com/ for
17-
detailed information). To automatically format the code according to ct-style, just mark the source-code
18-
and press *Ctrl+Shift+f*.
19-
2013

2114
Example command for running clang-tidy:
2215
\code

ct_doc/doc/installation.dox

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@ library versions as provided in the package sources.
2929
The following dependencies and bindings are optional but can help to enhance the functionality or performance of the CT
3030

3131
- <a href="http://www.netlib.org/lapack/">lapack</a> (enables Schur method as an alternative to iterative method in ct::optcon::LQR)
32+
\code{.sh} $ sudo apt-get install liblapack-dev \endcode
3233

3334
- <a href="https://clang.llvm.org/">clang</a> compiler (faster compilation for large linear models), install from command-line via
3435
\code{.sh} $ sudo apt-get install clang \endcode
3536
and possibly replace `clang` with a more specific version, e.g. `clang-3.8`.
3637
Please make sure that the `clang` and `clang++` commands are in your path.
3738
You may need to create a symbolic link in `/usr/bin` or use a bash alias.
3839

39-
- <a href="http://wiki.ros.org/indigo">ROS Indigo</a> or <a href="http://wiki.ros.org/kinetic">Kinetic</a> (for ROS bindings, visualization and extended examples), see <a href="../../../../ct_ros/ct_ros_nodes/doc/html/index.html">ct_ros_nodes</a>, <a href="../../../../ct_ros/ct_ros_nodes/doc/html/index.html">ct_ros_msgs</a>
40-
4140
- <a href="https://projects.coin-or.org/Ipopt">IPOPT</a> or <a href="http://www.sbsi-sol-optimize.com/asp/sol_product_snopt.htm">SNOPT</a>
4241
(for ct::optcon::SnoptSolver and ct::optcon::IpoptSolver as used by ct::optcon::DMS)
4342

ct_doc/doc/mainpage.dox

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
\section ct1 Control Toolbox
88

9-
This is the ADRL Control Toolbox ('CT'), an open-source C++ library for efficient modelling, control,
9+
The Control Toolbox ('CT'), an open-source C++ library for efficient modelling, control,
1010
estimation, trajectory optimization and model predictive control.
1111
The CT is applicable to a broad class of dynamic systems, but features additional modelling tools specially designed for robotics.
1212
This page outlines its general concept, its major building blocks and highlights selected application examples.
@@ -47,7 +47,7 @@ The CT was designed with the following features in mind:
4747
- all algorithm flavors and solver backends are available through simple configuration files.
4848

4949

50-
The CT is hosted on bitbucket: <a href="https://bitbucket.org/adrlab/ct" target="_blank">https://bitbucket.org/adrlab/ct</a>
50+
The CT is hosted on github: <a href="https://github.com/ethz-adrl/control-toolbox" target="_blank">https://github.com/ethz-adrl/control-toolbox</a>
5151

5252

5353

@@ -212,11 +212,6 @@ The four different main modules are detailed in the following.
212212
- <a href="../../../ct_models/doc/html/index.html">quick link to ct_models</a>
213213

214214

215-
\section source_code Source Code
216-
217-
The source code is available at <a href="https://bitbucket.org/adrlab/ct" target="_blank">https://bitbucket.org/adrlab/ct</a>
218-
219-
Examples for interfacing with ROS and advanced application examples are available at <a href="https://bitbucket.org/adrlab/ct_ros/src/master/" target="_blank">ct_ros</a>.
220215

221216
\section gs How to use the Control Toolbox
222217

@@ -226,15 +221,15 @@ To get started with the control toolbox, please see \ref getting_started "Gettin
226221
\section contact Support
227222

228223
For any questions, issues or other troubleshooting please either
229-
- create an issue: https://bitbucket.org/adrlab/ct/issues
224+
- create an issue: https://github.com/ethz-adrl/control-toolbox/issues
230225
- contact the devs: control-toolbox-dev@googlegroups.com
231226

232227

233228
\section ct_doc_acknowledgement Acknowledgements
234229

235230
\subsection contribs Contributors
236-
- Michael Neunert
237231
- Markus Giftthaler
232+
- Michael Neunert
238233
- Markus Stäuble
239234
- Farbod Farshidian
240235
- Diego Pardo
@@ -243,12 +238,11 @@ For any questions, issues or other troubleshooting please either
243238
- Ruben Grandia
244239
- Hamza Merzic
245240

246-
\subsection lead_overview Project Lead and Maintenance
247-
- Michael Neunert, neunertm (at) gmail (dot) com
241+
\subsection lead_overview Maintenance
248242
- Markus Giftthaler, markusgft (at) gmail (dot) com
249243

250-
\subsection funding Funding
251-
This software has been developed at the <a href="http://www.adrl.ethz.ch" target="_blank">Agile & Dexterous Robotics Lab</a>
244+
\subsection funding Funding 2014-2018
245+
The core of this software has been developed at the <a href="http://www.adrl.ethz.ch" target="_blank">Agile & Dexterous Robotics Lab</a>
252246
at <a href="http://www.ethz.ch/en" target="_blank">ETH Zurich</a>, Switzerland between 2014 and 2018.
253247
During that time, development has been made possible through financial support from the <a href="http://www.snf.ch/en/" target="_blank">Swiss National Science Foundation (SNF)</a>
254248
through a SNF Professorship award to Jonas Buchli and the National Competence Centers in Research (NCCR)

ct_doc/doc/tags/.gitkeep

Whitespace-only changes.

ct_models/doc/ct_models.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ct_models
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v2.3
41+
PROJECT_NUMBER = v3.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

ct_optcon/doc/ct_optcon.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ct_optcon
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v2.3
41+
PROJECT_NUMBER = v3.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

ct_rbd/doc/ct_rbd.doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = ct_rbd
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v2.3
41+
PROJECT_NUMBER = v3.0
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a

0 commit comments

Comments
 (0)