Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • ostasse/dynamic-graph-python
  • gsaurel/dynamic-graph-python
  • stack-of-tasks/dynamic-graph-python
3 results
Show changes
Commits on Source (223)
123 additional commits have been omitted to prevent performance issues.
Hide whitespace changes
Inline Side-by-side
Showing
with 195 additions and 611 deletions
.git-blame-ignore-revs 0 → 100644
View file @ a76b5b78
# pre-commit run -a (Guilhem Saurel, 2022-07-27)
db4d991c9d727b8454695ce8d88948b948c6b36f
.gitmodules
View file @ a76b5b78
[submodule "cmake"] [submodule "cmake"]
path = cmake path = cmake
url = git://github.com/jrl-umi3218/jrl-cmakemodules.git url = https://github.com/jrl-umi3218/jrl-cmakemodules.git
[submodule ".travis"]
path = .travis
url = git://github.com/jrl-umi3218/jrl-travis
.pre-commit-config.yaml 0 → 100644
View file @ a76b5b78
exclude: tests/test_python-syntax_error.py
ci:
autoupdate_branch: 'devel'
repos:
- repo: https://github.com/pre-commit/mirrors-clang-format
rev: v14.0.6
hooks:
- id: clang-format
args: [--style=Google]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.3.0
hooks:
- id: check-added-large-files
- id: check-ast
- id: check-executables-have-shebangs
- id: check-json
- id: check-merge-conflict
- id: check-symlinks
- id: check-toml
- id: check-yaml
- id: debug-statements
- id: destroyed-symlinks
- id: detect-private-key
- id: end-of-file-fixer
- id: fix-byte-order-marker
- id: mixed-line-ending
- id: trailing-whitespace
- repo: https://github.com/psf/black
rev: 22.8.0
hooks:
- id: black
- repo: https://github.com/PyCQA/flake8
rev: 5.0.4
hooks:
- id: flake8
- repo: https://github.com/cheshirekow/cmake-format-precommit
rev: v0.6.13
hooks:
- id: cmake-format
.travis @ 083fa2cb
Compare 083fa2cb...083fa2cb
Subproject commit 083fa2cb0fa4ad594926d9bb3d246075e62ce9ee
.travis.yml deleted 100644 → 0
View file @ 9587d5ed
language: cpp
sudo: required
compiler:
- gcc
- clang
env:
global:
- secure: ECiHIh0aT5ml/MdKifvFIM2UpDWiPsJPEZpafLYM8U0VAPYThSfUe8JWhMsky8amOwm38akbSbr6C7iBKVpzjAqpgNdOdufO1RUZ6pUvtlVXiXTw2KlqPqbDVlD3QroVDhnX/rIRcg5ezEHAIb594uEaHdf8tlikhjdTc3aAgMA=
- APT_DEPENDENCIES="doxygen doxygen-latex libboost-all-dev libeigen3-dev liblapack-dev libblas-dev gfortran python-dev python-sphinx"
- GIT_DEPENDENCIES="proyan/dynamic-graph"
- LCOV_IGNORE_RULES="*unitTesting*"
allow_failures:
- compiler: clang
notifications:
email:
- hpp-source@laas.fr
branches:
only:
- master
- debian
script: ./.travis/run build
after_success: ./.travis/run after_success
after_failure: ./.travis/run after_failure
before_install: ./.travis/run before_install
matrix:
allow_failures:
- compiler: clang
.yapfignore 0 → 100644
View file @ a76b5b78
tests/test_python-syntax_error.py
AUTHORS deleted 100644 → 0
View file @ 9587d5ed
Authors:
CMakeLists.txt
View file @ a76b5b78
# Copyright 2010, 2011, Florent Lamiraux, Thomas Moulard, JRL, CNRS/AIST # Copyright 2010-2020, Florent Lamiraux, Thomas Moulard, Olivier Stasse, Guilhem
# Saurel, JRL, CNRS/AIST, LAAS-CNRS
CMAKE_MINIMUM_REQUIRED(VERSION 2.8) cmake_minimum_required(VERSION 3.1)
SET(PROJECT_NAMESPACE stack-of-tasks) # Project properties
SET(PROJECT_NAME dynamic-graph-python) set(PROJECT_ORG stack-of-tasks)
SET(PROJECT_DESCRIPTION "Dynamic graph library Python bindings") set(PROJECT_NAME dynamic-graph-python)
SET(PROJECT_URL "http://github.com/${PROJECT_NAMESPACE}/${PROJECT_NAME}") set(PROJECT_DESCRIPTION "Dynamic graph library Python bindings")
set(PROJECT_URL "https://github.com/${PROJECT_ORG}/${PROJECT_NAME}")
INCLUDE(cmake/base.cmake) # Project options
INCLUDE(cmake/boost.cmake) option(SUFFIX_SO_VERSION "Suffix library name with its version" ON)
INCLUDE(cmake/eigen.cmake)
INCLUDE(cmake/pthread.cmake)
include(cmake/python.cmake)
INCLUDE(cmake/sphinx.cmake)
SET(DOXYGEN_USE_MATHJAX YES) # Project configuration
set(PROJECT_USE_CMAKE_EXPORT TRUE)
set(CUSTOM_HEADER_DIR "dynamic-graph/python")
set(CXX_DISABLE_WERROR TRUE)
set(DOXYGEN_USE_MATHJAX YES)
SET(CUSTOM_HEADER_DIR "dynamic-graph/python") # JRL-cmakemodule setup
include(cmake/base.cmake)
include(cmake/boost.cmake)
SET(PKG_CONFIG_ADDITIONAL_VARIABLES plugindir ${PKG_CONFIG_ADDITIONAL_VARIABLES}) # Project definition
compute_project_args(PROJECT_ARGS LANGUAGES CXX)
project(${PROJECT_NAME} ${PROJECT_ARGS})
check_minimal_cxx_standard(14 ENFORCE)
PROJECT(${PROJECT_NAME} CXX) # Project dependencies
set(PYTHON_COMPONENTS Interpreter Development NumPy)
add_project_dependency(dynamic-graph 4.4.0 REQUIRED)
add_project_dependency(eigenpy 2.7.10 REQUIRED)
set(PYTHON_EXPORT_DEPENDENCY_MACROS
"list(APPEND PYTHON_COMPONENTS ${PYTHON_COMPONENTS})\n${PYTHON_EXPORT_DEPENDENCY_MACROS}"
)
if(BUILD_TESTING)
find_package(Boost REQUIRED COMPONENTS unit_test_framework)
endif(BUILD_TESTING)
FINDPYTHON(2.7 EXACT REQUIRED) if(Boost_VERSION GREATER 107299 OR Boost_VERSION_MACRO GREATER 107299)
# Silence a warning about a deprecated use of boost bind by boost >= 1.73
# without dropping support for boost < 1.73
add_definitions(-DBOOST_BIND_GLOBAL_PLACEHOLDERS)
endif()
# Trigger dependency to dynamic-graph. # Main Library
ADD_REQUIRED_DEPENDENCY("dynamic-graph >= 3.0.0") set(${PROJECT_NAME}_HEADERS
include/${CUSTOM_HEADER_DIR}/api.hh
include/${CUSTOM_HEADER_DIR}/convert-dg-to-py.hh
include/${CUSTOM_HEADER_DIR}/dynamic-graph-py.hh
include/${CUSTOM_HEADER_DIR}/fwd.hh
include/${CUSTOM_HEADER_DIR}/interpreter.hh
include/${CUSTOM_HEADER_DIR}/module.hh
include/${CUSTOM_HEADER_DIR}/python-compat.hh
include/${CUSTOM_HEADER_DIR}/signal.hh
include/${CUSTOM_HEADER_DIR}/signal-wrapper.hh)
# Add dependency toward dynamic graph library in pkg-config file. set(${PROJECT_NAME}_SOURCES
PKG_CONFIG_APPEND_LIBS("dynamic-graph-python") src/interpreter.cc src/dynamic_graph/python-compat.cc
src/dynamic_graph/entity-py.cc src/dynamic_graph/convert-dg-to-py.cc)
# Search for Boost. add_library(${PROJECT_NAME} SHARED ${${PROJECT_NAME}_SOURCES}
SET(BOOST_COMPONENTS python filesystem system thread program_options unit_test_framework) ${${PROJECT_NAME}_HEADERS})
SEARCH_FOR_BOOST() target_include_directories(${PROJECT_NAME} PUBLIC $<INSTALL_INTERFACE:include>)
SEARCH_FOR_EIGEN() target_link_libraries(${PROJECT_NAME} PUBLIC dynamic-graph::dynamic-graph)
modernize_target_link_libraries(
${PROJECT_NAME}
SCOPE
PUBLIC
TARGETS
Python${PYTHON_VERSION_MAJOR}::Python
LIBRARIES
${PYTHON_LIBRARIES}
INCLUDE_DIRS
${PYTHON_INCLUDE_DIRS})
target_link_boost_python(${PROJECT_NAME} PUBLIC)
ADD_SUBDIRECTORY(src) if(SUFFIX_SO_VERSION)
ADD_SUBDIRECTORY(include) set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${PROJECT_VERSION})
ADD_SUBDIRECTORY(doc) endif(SUFFIX_SO_VERSION)
ADD_SUBDIRECTORY(unitTesting)
target_compile_definitions(${PROJECT_NAME}
PRIVATE PYTHON_LIBRARY="${PYTHON_LIBRARY}")
install(
TARGETS ${PROJECT_NAME}
EXPORT ${TARGETS_EXPORT_NAME}
DESTINATION lib)
add_subdirectory(src)
if(BUILD_TESTING)
add_subdirectory(tests)
endif(BUILD_TESTING)
install(FILES package.xml DESTINATION share/${PROJECT_NAME})
COPYING
View file @ a76b5b78
BSD 2-Clause License BSD 2-Clause License
Copyright (c) 2018, CNRS Copyright (c) 2011-2019, CNRS
Author: Stack of Tasks Development Team Author: Stack of Tasks Development Team
All rights reserved. All rights reserved.
......
ChangeLog deleted 100644 → 0
View file @ 9587d5ed
CHANGELOG
----------------------
[Current]
* Synchronize
* Allow iterable instead of only tuple in signal value affectation.
* Synchronize.
* Fix compilation on Ubuntu 10.04 (32 bits).
* Fix Ubuntu 12.04 (64 bits) portability issues.
* Corrected the #include problem.
* Modify SignalBase.value.
[v2.5.3]
* Update ChangeLog.
* Fix pb with filesystem version.
[v2.5.2]
* Make runCommand without error messages deprecated.
* Changes std::cout to dgDEBUG.
* Add test to detect statement in evaluation.
* Synchronize cmake
* Robustify the python interpreter when some python objects cannot be stringified.
* Synchronize.
* Correct the link with boost on Ubuntu 11.04.
* Keep track of entities created via python.
* Document entity class types with the output of C++ getDocString method.
* In command Entity.help (), first print __doc__ if any.
* Make bindings more robust to exceptions.
* Make sure that Boost.Filesystem v2 is used.
* Revert "Add appropriate flag. file_system::file_string is deprecated since boost 1.46."
* Synchronize cmake submodule.
* Catch exceptions in getValue of signal-base-py.cc
* Add appropriate flag. file_system::file_string is deprecated since boost 1.46.
* Synchronize.
* Win32: Remove wrong LoadLibrary.
* Correct the handling of python modules
* Correct the link with boost for Mac systems
* Add missing dependency in python
* Correct the link with the plugins for the wrap
* Correct the Python_module handling
* Correct link and dependencies
* Clean cmake files by using the routines in cmake/python.cmake
* Win32: correct the library load
* Win32: Correct the API of exception-python.hh
* Revert "Correct the link with lapack"
* Correct the link with lapack
* Correct the link with boost libraries
* Python object SignalBase can be constructed only with a SignalBase C++ object.
* Revert "Modify SignalBase.value."
* Modify SignalBase.value.
[v2.5.1]
* Update NEWS.
* Add python binding for writing graph.
* Make error message more expressive.
* Enforce compatibility with python3.
* Replace dl module by DLFCN.
* More search for boost earlier in file.
* Synchronize and fix definition of PYTHON_SITELIB.
* Add dynamicgraph namespace to make VP_DEBUG mode compile.
* Minor changes in matlab display. Add a functor member to explicit the callable of optionalparentethis.
* Add tools.py file containing addTrace.
[v2.5]
* Replace call to g_caster by call to SignalCaster::getInstance static method.
* FactoryStorage and PoolStorage are now singletons.
* Homogeneize error messages.
* Fix bug in getCommandDocstring.
* Changed the factory to enable heritage for Entity py-classes.
* Return a python error instead of throwing C++ exception.
* Merge branches 'topic/jrl-mal' and 'topic/jrl-mal' of ssh://github.com/jrl-umi3218/dynamic-graph-python into topic/jrl-mal
* Correct a bug in parsing vector commands with integer value.
* Finished to correct the name of the DG error.
* Replace two remaining error by dgpyError.
* Correct exception throwing from C++ to rely raise something in the interpreter.
* Systematically catch std::exception abstract in python bindings.
* Corrected a wrong cast for specialized type in signal value accessor.
* Add method intepreter::python with stdout and stderr returned along with result.
* Make error message more specific whenever Entity.__getattr__ fails.
* Added a protection to avoid erasing signal name when setting a new value to the signal.
* Added the decorator optionalparentheses.
* Corrected a syntax error in an exception raising + remove the shortcut .m from the class basic definition.
* Corrected minor bug in command return.
* Added the entity.sigs shortcuts.
* Reorganize the command bindings of the entity classes. Remove the script shortcuts from the basic definition of Entity.
* Added the setattrpath function to handle for command name with . inside, like: robot.periodicCall.addSignal.
* Display repr() output instead of str() when command is successful.
* Do not add current directory in sys.path.
* Added a proper factory for pyEntities.
* Modify the "runFile" function that was not working, at create a new function to call for the shell.
* Changed the call to create_entity: when the required creation names already exists, check is the existing object is of the same class. If it is, returns the existing object instead of creating a new oine.
* IVIGIT.
* Added an exception to handle error while creating an object.
* Dynamically load libpython.so before initializing python interpreter.
* Add an accessor to get the global dictionary.
* Account for singleton rewriting of g_caster.
* Added a wrapper for entities of dg.
* Added display and displayDep in entity and signal.
* Bind SignalBase<T, int>::setTime.
* Revert "Set version number as 1.99."
* Fix --libs output of pkg-config and link boost and python with library.
* Added missing convert.cc in the makefile.
* Added some specific convertion for vector, matrix and double signal, from C to Python (to avoid unnecessary convertion through strings.
* IVIGIT: passes some conveertion code from entity-py to the new files, for mutualisation.
* Added exception.hh in the files to install.
* IVIGIT.
* Install and include in interpreter.hh api.hh.
* Fix installation of header file.
* Set version number as 1.99.
* Enable conversion from int to float and double in argument of bound functions.
* Added the display method, py-bound in __str__.
* Added a method to bound all new commands.
* Added a method to bound new commands dynamically.
* Define function display.
* Enable reading an int as a float when parsing a matrix.
* Added shortcuts in the entity and signal-base api to help debuging during online script execution.
* Added the unplug python function as a member of the signal-base class.
* Set sys.argv to [''] at initialization.
* Implement on-board python interpreter
* Added build and ~ in the gitignoe.
* Update docstring of Entity.signals().
* Bind SignalBase.display() and implement Entity.displaySignals() in python.
* Fix typo.
* Fix warnings.
* Save temporary changes to get list of signals of an entity.
* Synchronize cmake submodule.
* Raise exception when PyCObject_Check fails.
* Fix warnings.
* Switch to submodule.
* Do not destroy C++ entity when destroying python binding object.
* In Entity class, each signal gives rise to an attribute returning the signal.
* Change the error message when an attribute does not exist.
* Add a method getName in python class SignalBase
* Added the signals in the attribute of the entity class.
* With the doc.
* Added an helper to get the commands list and doc.
* Set error message in function w_plug when arguments are of wrong types.
* Add a function to get the list of type names registered for signals.
* Catch exception in SignalBase::recompute().
* Rename method display_signals -> displaySignals.
* Add recompute method in SignalBase python class.
* Add a function to get the list of type names registered for signals.
* Rename error
* Rewrite enableTrace command without using commandLine.
* Handle entity type as input to signal_base.value setter.
* Catch std::exception instead of dynamicgraph::ExceptionFactory.
* Remove debug output.
* Fix a bug in conversion of tuple of tuple python object to matrix.
* Rewrite stringToTuple and stringToMatrix in a simpler way.
* Set flags of dynamic loader so that symbols are global.
* Check that argument is string when string is expected in command.
* Catch std::exception when executing command
* Comply with jrl-mal syntax for vectors and matrices.
* Replace object member by obj in classes
* Rename method in python module
* When building python Entity classes, populate methods with docstrings.
* Use autotools substitution rule.
* Use submodule cmake to generate python documentation
* Add documentation generation using sphinx.
* Add submodule cmake
* Re-inforce type checking.
* Allow SignalBase.value to take typed arguments
* Remove debug output
* Remove debug output
* Implement tupleToString function
* Fix typo.
* Switch arguments of command plug.
* Fix a bug in handling of new types
* Support more types in command parameters
* Add a function to convert a string to a tuple
* Fix memory issue
* Remove trailing white spaces.
* Bind Entity commands as method in python classes
* Get rid of warning message
* Bind method Entity::getNewStyleCommandMap()
* Add a class attribute to store whether command methods have been created.
* Register Entity classes in modules from which they are imported
* Implement a function that creates a python class for for each entity C++ class
* Implement return value for commands.
* Fix a memory bug
* Add some debug output
* Implement binidings for commands
* Use factory to create entities.
* Bind method Entity::listEntities.
* Fix comment
* Make classes derive from object and re-introduce getter and setter decorators
* Remove registration of new ublas vector type.
* Call plug with right order for signals: plug (sigIn, sigOut).
* Rewrite dynamic_graph.plug.
* Use class InterpreterHelper instead of Interpreter.
* Catch exceptions in signal set and get value methods.
* Catch exceptions in signal set and get value methods.
* Do not use sophisticated setter and getter for the moment
* Change signal access method name in Entity python class
* Adapt to dynamic-graph change of interface
* Implement set and get signal value
* Fix constructor of python class SignalBase.
* Implement bindings for Entity and SignalBase C++ classes.
* Raise a python exception upon c++ exception in plug command
* Implement binding python for plug.
* Fix compilation of python module
* Bindings python for dynamic_grapĥ.
INSTALL deleted 100644 → 0
View file @ 9587d5ed
#
# Copyright
#
Installation instructions for library dynamic-graph-python
----------------------------------------------
It is recommended to create a specific directory to install this package.
mkdir build
cd build
cmake [Options] ..
make
make install
Options:
-DCMAKE_INSTALL_PREFIX=...
specifies the directory where to install the package.
-DCMAKE_BUILD_TYPE=[none|debug|release|relwithdebinfo|MinSizeRel]
specifies to type of compilation (release, debug, ...)
NEWS deleted 100644 → 0
View file @ 9587d5ed
New in version 2.5.1 - 2011-12-07
* Move search for boost earlier in CMakeLists.txt,
* Use PyObject_IsTrue to test a boolean C/Python API,
* Replace deprecated python module dl module by DLFCN,
* use print as a function for python 3 compatibility,
* Modification of signal management for vector and matrix data,
* Python files are now installed in site-packages instead of dist-packages,
* Add tools.py file containing addTrace.
New in version 2.5 - 2011-06-21
README.md
View file @ a76b5b78
dynamic-graph-python # dynamic-graph-python
====================
[![Building Status](https://travis-ci.org/stack-of-tasks/dynamic-graph-python.svg?branch=master)](https://travis-ci.org/stack-of-tasks/dynamic-graph-python) [![Building Status](https://travis-ci.org/stack-of-tasks/dynamic-graph-python.svg?branch=master)](https://travis-ci.org/stack-of-tasks/dynamic-graph-python)
[![Pipeline status](https://gepgitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/pipeline.svg)](https://gepgitlab.laas.fr/stack-of-tasks/dynamic-graph-python/commits/master) [![Pipeline status](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/pipeline.svg)](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/commits/master)
[![Coverage report](https://gepgitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/stack-of-tasks/doc/stack-of-tasks/dynamic-graph-python/master/coverage/) [![Coverage report](https://gitlab.laas.fr/stack-of-tasks/dynamic-graph-python/badges/master/coverage.svg?job=doc-coverage)](http://projects.laas.fr/stack-of-tasks/doc/stack-of-tasks/dynamic-graph-python/master/coverage/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/stack-of-tasks/dynamic-graph-python/master.svg)](https://results.pre-commit.ci/latest/github/stack-of-tasks/dynamic-graph-python)
Python bindings for dynamic-graph. Python bindings for dynamic-graph.
...@@ -14,52 +15,19 @@ submodules][git-submodules]. Please clone this repository using the ...@@ -14,52 +15,19 @@ submodules][git-submodules]. Please clone this repository using the
repository, you can run `git submodule init && git submodule update` repository, you can run `git submodule init && git submodule update`
to retrieve the submodules. to retrieve the submodules.
## Documentation
Documentation [Online](https://gepettoweb.laas.fr/doc/stack-of-tasks/dynamic-graph-python/master/doxygen-html/)
-------------
To get started with this library, please read the [online Doxygen
documentation][doxygen-documentation].
It can also be generated locally by running the `make doc` ## Getting Help
command. After the package is installed, the documentation will be
located in the `$prefix/share/doc/dynamic-graph` directoy where
`$prefix` is your installation prefix (`/usr/local` by default).
Getting Help
------------
Support is provided through: Support is provided through:
* the HPP mailing-list: hpp@laas.fr * the [issue tracker](https://github.com/stack-of-tasks/dynamic-graph-python/issues)
* the following HipChat room: http://www.hipchat.com/gh4wQrZeV * the matrix room [#stack-of-tasks:laas.fr](https://matrix.to/#/#stack-of-tasks:laas.fr)
How can I install dynamic-graph?
--------------------------------
### Installing dependencies
The matrix abstract layer depends on several packages which
have to be available on your machine.
- Libraries:
- [Boost][] (>= 1.40)
Its detection is controled by the `BOOST_ROOT` variable, see next section
for more information.
- [Lapack][] library
Use the generic purpose `CMAKE_CXX_FLAGS` and `CMAKE_EXE_LINKER_FLAGS`
to insert the flags required for the compiler to find your Lapack library
if it is installed in a non-standard directory.
- [jrl-mal][] library
- [dynamic-graph][] library
- System tools:
- [CMake][] (>=2.6)
- [pkg-config][]
- usual compilation tools (GCC/G++, make, etc.)
If you are using Ubuntu, these tools are gathered in the `build-essential` package.
## How can I install dynamic-graph?
### Compiling and installing the package ### Compiling and installing the package
...@@ -68,24 +36,21 @@ The manual compilation requires two steps: ...@@ -68,24 +36,21 @@ The manual compilation requires two steps:
1. configuration of the build and generation of the build files 1. configuration of the build and generation of the build files
2. compilation of the sources and installation of the package 2. compilation of the sources and installation of the package
dynamic-graph uses [CMake][] to generate build files. It is dynamic-graph uses CMake to generate build files. It is
recommended to create a separate build directory: recommended to create a separate build directory:
```sh ```sh
mkdir _build # (1) Create a build directory mkdir build
cd _build # (2) Go to the newly created build directory cd build
cmake [options] .. # (3) Generate the build files cmake ..
``` ```
Options which can be passed to CMake are detailed in the next section.
```sh ```sh
make # (4) Compile the package make
make test # (5) Execute the package tests make test
make install # (6) Install the package into the prefix (see step 3) make install
``` ```
### Options ### Options
Additional options can be set on the command line through the Additional options can be set on the command line through the
...@@ -109,14 +74,8 @@ Available options are: ...@@ -109,14 +74,8 @@ Available options are:
The test suite can be run from your build directory by running: The test suite can be run from your build directory by running:
```sh ```sh
make test make test
``` ```
Please open a ticket if some tests are failing on your computer, it Please open a ticket if some tests are failing on your computer, it
should not be the case. should not be the case.
Credits
-------
This package authors are credited in the [AUTHORS](AUTHORS) file.
cmake @ 08c2c18b
Subproject commit d14225f15cff165773176ae0740d0ee79767ff93 Subproject commit 08c2c18b9033c2f0a86b885b589f4fa63a163caf
doc/CMakeLists.txt deleted 100644 → 0
View file @ 9587d5ed
# Copyright 2010, 2011, Florent Lamiraux, Thomas Moulard, JRL, CNRS/AIST
SPHINX_SETUP()
SPHINX_FINALIZE()
doc/footer.html
View file @ a76b5b78
...@@ -8,4 +8,3 @@ ...@@ -8,4 +8,3 @@
</center> </center>
</body> </body>
</head> </head>
doc/header.html
View file @ a76b5b78
...@@ -4,4 +4,3 @@ ...@@ -4,4 +4,3 @@
<LINK HREF="package.css" REL="stylesheet" TYPE="text/css"> <LINK HREF="package.css" REL="stylesheet" TYPE="text/css">
</HEAD> </HEAD>
<BODY> <BODY>
doc/package.css
View file @ a76b5b78
...@@ -45,8 +45,8 @@ a:link { ...@@ -45,8 +45,8 @@ a:link {
color:#0066CC color:#0066CC
} }
a:hover, a:active { a:hover, a:active {
text-decoration: underline; text-decoration: underline;
color: #3C9A35; color: #3C9A35;
} }
...@@ -57,7 +57,7 @@ a:visited { ...@@ -57,7 +57,7 @@ a:visited {
} }
DIV.memitem DIV.memitem
{ {
spacing: 10px; spacing: 10px;
width:100%; width:100%;
background:#FFFFFF; background:#FFFFFF;
...@@ -70,7 +70,7 @@ DIV.memitem ...@@ -70,7 +70,7 @@ DIV.memitem
} }
DIV.memproto DIV.memproto
{ {
width:100%; width:100%;
background:#F0F0F0; background:#F0F0F0;
font-size:100%; font-size:100%;
...@@ -82,7 +82,7 @@ DIV.memproto ...@@ -82,7 +82,7 @@ DIV.memproto
} }
DIV.memdoc DIV.memdoc
{ {
padding: 10px; padding: 10px;
width:100%; width:100%;
font-size:100%; font-size:100%;
...@@ -189,7 +189,7 @@ DIV.nav ...@@ -189,7 +189,7 @@ DIV.nav
} }
DIV.groupHeader DIV.groupHeader
{ {
padding-top: 30px; padding-top: 30px;
padding-bottom: 20px; padding-bottom: 20px;
background : none; background : none;
...@@ -201,23 +201,23 @@ DIV.groupHeader ...@@ -201,23 +201,23 @@ DIV.groupHeader
color:#0066CC; color:#0066CC;
} }
.directory p .directory p
{ {
margin: 0px; margin: 0px;
white-space: nowrap; white-space: nowrap;
font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif;
font-size: 10pt; font-size: 10pt;
font-weight: normal; font-weight: normal;
} }
.directory h3 .directory h3
{ {
font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif; font-family: 'Lucida Grande','Lucida Sans Unicode',Verdana,Sans-Serif;
margin: 0px; margin: 0px;
margin-top: 1em; margin-top: 1em;
padding-bottom: 20px; padding-bottom: 20px;
font-size: 12pt; font-size: 12pt;
font-variant: small-caps; font-variant: small-caps;
text-align: center; text-align: center;
} }
...@@ -227,4 +227,3 @@ DIV.groupHeader ...@@ -227,4 +227,3 @@ DIV.groupHeader
text-decoration: none; text-decoration: none;
color:#0066CC color:#0066CC
} }
doc/package.dox.cmake → doc/package.dox.in
View file @ a76b5b78
...@@ -23,8 +23,8 @@ ABBREVIATE_BRIEF = "The $name class" \ ...@@ -23,8 +23,8 @@ ABBREVIATE_BRIEF = "The $name class" \
ALWAYS_DETAILED_SEC = YES ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO FULL_PATH_NAMES = NO
STRIP_FROM_PATH = STRIP_FROM_PATH =
STRIP_FROM_INC_PATH = STRIP_FROM_INC_PATH =
SHORT_NAMES = NO SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO MULTILINE_CPP_IS_BRIEF = NO
...@@ -50,7 +50,7 @@ SORT_MEMBER_DOCS = YES ...@@ -50,7 +50,7 @@ SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO SORT_BY_SCOPE_NAME = NO
MAX_INITIALIZER_LINES = 30 MAX_INITIALIZER_LINES = 30
FILE_VERSION_FILTER = FILE_VERSION_FILTER =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to warning and progress messages # configuration options related to warning and progress messages
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -60,18 +60,18 @@ WARN_IF_UNDOCUMENTED = YES ...@@ -60,18 +60,18 @@ WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text" WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = WARN_LOGFILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
RECURSIVE = YES RECURSIVE = YES
EXCLUDE = EXCLUDE =
EXCLUDE_SYMLINKS = NO EXCLUDE_SYMLINKS = NO
EXAMPLE_PATH = EXAMPLE_PATH =
EXAMPLE_PATTERNS = * EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO EXAMPLE_RECURSIVE = NO
INPUT_FILTER = INPUT_FILTER =
FILTER_PATTERNS = FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO FILTER_SOURCE_FILES = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to source browsing # configuration options related to source browsing
...@@ -81,7 +81,7 @@ FILTER_SOURCE_FILES = NO ...@@ -81,7 +81,7 @@ FILTER_SOURCE_FILES = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5 COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX = IGNORE_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the HTML output # configuration options related to the HTML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -89,8 +89,8 @@ GENERATE_HTML = YES ...@@ -89,8 +89,8 @@ GENERATE_HTML = YES
HTML_FILE_EXTENSION = .html HTML_FILE_EXTENSION = .html
HTML_ALIGN_MEMBERS = YES HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO GENERATE_HTMLHELP = NO
CHM_FILE = CHM_FILE =
HHC_LOCATION = HHC_LOCATION =
GENERATE_CHI = NO GENERATE_CHI = NO
BINARY_TOC = NO BINARY_TOC = NO
TOC_EXPAND = YES TOC_EXPAND = YES
...@@ -106,8 +106,8 @@ LATEX_CMD_NAME = latex ...@@ -106,8 +106,8 @@ LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO COMPACT_LATEX = NO
PAPER_TYPE = a4wide PAPER_TYPE = a4wide
EXTRA_PACKAGES = EXTRA_PACKAGES =
LATEX_HEADER = LATEX_HEADER =
PDF_HYPERLINKS = NO PDF_HYPERLINKS = NO
USE_PDFLATEX = NO USE_PDFLATEX = NO
LATEX_BATCHMODE = NO LATEX_BATCHMODE = NO
...@@ -118,8 +118,8 @@ LATEX_HIDE_INDICES = NO ...@@ -118,8 +118,8 @@ LATEX_HIDE_INDICES = NO
RTF_OUTPUT = rtf RTF_OUTPUT = rtf
COMPACT_RTF = NO COMPACT_RTF = NO
RTF_HYPERLINKS = NO RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE = RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE = RTF_EXTENSIONS_FILE =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the man page output # configuration options related to the man page output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -130,8 +130,8 @@ MAN_LINKS = NO ...@@ -130,8 +130,8 @@ MAN_LINKS = NO
# configuration options related to the XML output # configuration options related to the XML output
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
XML_OUTPUT = xml XML_OUTPUT = xml
XML_SCHEMA = XML_SCHEMA =
XML_DTD = XML_DTD =
XML_PROGRAMLISTING = YES XML_PROGRAMLISTING = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output # configuration options for the AutoGen Definitions output
...@@ -142,20 +142,20 @@ GENERATE_AUTOGEN_DEF = NO ...@@ -142,20 +142,20 @@ GENERATE_AUTOGEN_DEF = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
PERLMOD_LATEX = NO PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX = PERLMOD_MAKEVAR_PREFIX =
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the preprocessor # Configuration options related to the preprocessor
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES SEARCH_INCLUDES = YES
INCLUDE_PATH = INCLUDE_PATH =
INCLUDE_FILE_PATTERNS = INCLUDE_FILE_PATTERNS =
EXPAND_AS_DEFINED = EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES SKIP_FUNCTION_MACROS = YES
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to external references # Configuration::additions related to external references
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
TAGFILES = \ TAGFILES = \
${DYNAMIC_GRAPH_DOCDIR}/html/dynamic-graph.doxytag=${DYNAMIC_GRAPH_DOCDIR}/html ${DYNAMIC_GRAPH_DOCDIR}/html/dynamic-graph.doxytag=${DYNAMIC_GRAPH_DOCDIR}/html
...@@ -164,10 +164,10 @@ ALLEXTERNALS = NO ...@@ -164,10 +164,10 @@ ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl PERL_PATH = /usr/bin/perl
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the dot tool # Configuration options related to the dot tool
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to the search engine # Configuration::additions related to the search engine
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
SEARCHENGINE = NO SEARCHENGINE = NO
...@@ -196,7 +196,7 @@ GENERATE_TODOLIST = YES ...@@ -196,7 +196,7 @@ GENERATE_TODOLIST = YES
GENERATE_TESTLIST = NO GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= YES GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS = ENABLED_SECTIONS =
SHOW_USED_FILES = NO SHOW_USED_FILES = NO
SHOW_DIRECTORIES = NO SHOW_DIRECTORIES = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
...@@ -206,7 +206,7 @@ SHOW_DIRECTORIES = NO ...@@ -206,7 +206,7 @@ SHOW_DIRECTORIES = NO
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
FILE_PATTERNS = *.hh *.idl FILE_PATTERNS = *.hh *.idl
EXCLUDE_PATTERNS = EXCLUDE_PATTERNS =
INPUT = ${${PROJECT_NAME}_SOURCE_DIR}/include \ INPUT = ${${PROJECT_NAME}_SOURCE_DIR}/include \
${CMAKE_CURRENT_SOURCE_DIR}/additionalDoc ${CMAKE_CURRENT_SOURCE_DIR}/additionalDoc
...@@ -260,13 +260,13 @@ GENERATE_AUTOGEN_DEF = NO ...@@ -260,13 +260,13 @@ GENERATE_AUTOGEN_DEF = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
GENERATE_PERLMOD = NO GENERATE_PERLMOD = NO
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the preprocessor # Configuration options related to the preprocessor
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration::additions related to external references # Configuration::additions related to external references
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# Configuration options related to the dot tool # Configuration options related to the dot tool
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = YES HIDE_UNDOC_RELATIONS = YES
...@@ -282,8 +282,8 @@ CALL_GRAPH = NO ...@@ -282,8 +282,8 @@ CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png DOT_IMAGE_FORMAT = png
DOT_PATH = DOT_PATH =
DOTFILE_DIRS = DOTFILE_DIRS =
MAX_DOT_GRAPH_DEPTH = 1000 MAX_DOT_GRAPH_DEPTH = 1000
DOT_TRANSPARENT = NO DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = YES DOT_MULTI_TARGETS = YES
......
doc/sphinx/conf.py.in deleted 100644 → 0
View file @ 9587d5ed
# -*- coding: utf-8 -*-
#
# @PROJECT_NAME@ documentation build configuration file, created by
# sphinx-quickstart on Mon Nov 22 16:45:27 2010.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
from sphinx import version_info as sphinx_version
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path = [os.path.abspath('@CMAKE_BINARY_DIR@/src')]+sys.path
sys.path = [os.path.abspath('@CMAKE_SOURCE_DIR@/src')]+sys.path
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
extensions.append('sphinx.ext.pngmath' if sphinx_version < (1, 4) else 'sphinx.ext.imgmath')
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'@PROJECT_NAME@'
copyright = u'2010, Florent Lamiraux'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
#unused_docs = []
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_use_modindex = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = '@PROJECT_NAME@doc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', '@PROJECT_NAME@.tex', u'@PROJECT_NAME@ Documentation',
u'Florent Lamiraux', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_use_modindex = True
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}