diff --git a/manual/conf.py b/manual/conf.py index 540b676..fae3666 100644 --- a/manual/conf.py +++ b/manual/conf.py @@ -1,221 +1,221 @@ # -*- coding: utf-8 -*- import sys, os # 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.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # 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.intersphinx' ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] master_doc = 'index' # The master toctree document. source_suffix = '.rst' # The suffix of source filenames. #source_encoding = 'utf-8-sig' # The encoding of source files. # General information about the project. project = 'oncilla-sim' version = '0.1' # The short X.Y version. release = '0.1.0' # The full version copyright = u'2012, Arne Nordmann, Alexandre Tuleu' language = 'en' # Language for autogenerated # content rst_prolog = """ .. |project| replace:: Oncilla-Sim .. |repository| replace:: https://redmine.amarsi-project.eu/git/oncillasim.git .. _`AMARSi`: https://amarsi-project.eu .. _`rsc`: http://code.cor-lab.org/svn/rsc .. _`rsb`: http://docs.cor-lab.org/rsb-manual .. _`rst`: http://docs.cor-lab.org/rst-manual .. _spread: http://www.spread.org .. _cmake: http://www.cmake.org/ .. _google protocol buffers: http://code.google.com/p/protobuf/ .. _Doxygen: http://www.doxygen.nl/ .. _Lcov: http://ltp.sourceforge.net/coverage/lcov.php .. _cppcheck: http://sourceforge.net/apps/mediawiki/cppcheck/index.php?title=Main_Page .. _boost: http://www.boost.org/ .. _boost.uuid: http://www.boost.org/doc/libs/1_42_0/libs/uuid/uuid.html .. |ubuntu| replace:: Ubuntu GNU/Linux """ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['_build'] # 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 --------------------------------------------------- -html_theme = 'nature' +html_theme = 'corlab' #html_theme_options = {} -#html_theme_path = [] +html_theme_path = ['.'] # The name for this set of Sphinx documents. If None, it defaults to # " v 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 = { '**': [ 'globaltoc.html', 'links.html', 'sourcelink.html', 'searchbox.html' ] } # 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'oncilla-sim-manual' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { 'papersize': 'a4paper', 'pointsize': '10pt' } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'oncilla-sim-manual.tex', u'Oncilla-Sim Manual', u'Arne Nordmann, Alexandre Tuleu', '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 # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('info', 'info', u'info Program', [u'Jan Moringen'], 1), ('logger', 'logger', u'logger Program', [u'Jan Moringen'], 1), ('send', 'send', u'send Progam', [u'Jan Moringen'], 1), ('call', 'call', u'call Progam', [u'Jan Moringen'], 1) ] # -- Options for intersphinx --------------------------------------------------- intersphinx_mapping = { 'python': ('http://docs.python.org/', None), } external_modules_list=os.environ['sphinx_external_modules'] if len(external_modules_list) > 0 : for m in os.environ['sphinx_external_modules'].split(':'): if os.environ.has_key(m): intersphinx_mapping[m] = (os.environ[m], None) diff --git a/manual/corlab/theme.conf b/manual/corlab/theme.conf new file mode 100644 index 0000000..d422f2e --- /dev/null +++ b/manual/corlab/theme.conf @@ -0,0 +1,4 @@ +[theme] +inherit = nature +stylesheet = corlab.css +pygments_style = sphinx diff --git a/manual/index.rst b/manual/index.rst index fa2f4ad..e7e1638 100644 --- a/manual/index.rst +++ b/manual/index.rst @@ -1,19 +1,22 @@ .. _oncilla-sim: =========== |project| =========== |project| Manual (for version |version|) ======================================== .. image:: images/oncilla-sim.png :width: 200px :align: right :target: _images/oncilla-sim.png |project| is the central project for the Oncilla Quadruped Simulation, developed in the `AMARSi`_ project. |project| contains a :ref:`Project Wizard `, that helps you set up new simulation projects and experiments, and installs :ref:`Examples ` for the usage of the different API layers. + +The Simulator is based on the `Webots `_ +Simulator by Cyberbotics and requires a Webots ``PRO License``. diff --git a/manual/preparation.rst b/manual/preparation.rst index a7c3fba..48b3809 100644 --- a/manual/preparation.rst +++ b/manual/preparation.rst @@ -1,43 +1,43 @@ .. _preparation: ============== Installation ============== Installing |project| ==================== There are currently two ways to install the |version| version of |project|: * |ubuntu| packages * From source (undocumented yet, but uses python setup.py standard packaging) |ubuntu| Packages ----------------- Debian packages for |ubuntu| are available from the `CoR-Lab package repository `_ , `Biorob repository `_ and `Cyberbotics repositiory `_. In order to install these repositories in your system, please proceed like this:: eval `cat /etc/lsb-release` && echo deb http://biorob2.epfl.ch/users/tuleu/ubuntu $DISTRIB_CODENAME main | sudo tee /etc/apt/sources.list.d/biorob-tuleu.list eval `cat /etc/lsb-release` && echo deb http://packages.cor-lab.de/ubuntu $DISTRIB_CODENAME main | sudo tee /etc/apt/sources.list.d/cor-lab.list echo deb http://www.cyberbotics.com/debian/ binary-i386/ | sudo tee /etc/apt/sources.list.d/cyberbotics.list echo deb http://www.cyberbotics.com/debian/ binary-amd64/ | sudo tee -a /etc/apt/sources.list.d/cyberbotics.list wget -O - http://biorob2.epfl.ch/users/tuleu/ubuntu/gpg.key | sudo apt-key add - wget -O - https://webdav.cor-lab.de/server_keys/packages.cor-lab.de_server_key.txt | sudo apt-key add - wget -O - http://www.cyberbotics.com/Cyberbotics.asc | sudo apt-key add - -Then install :doc:`NemoMath `. +Then download and install :doc:`NemoMath `. Then you can install the packages needed for the simulator:: sudo aptitude update sudo aptitude install oncilla-sim liboncilla-dev liboncilla-webots-dev webots -Now you are ready to use :ref:`oncilla-sim-wizard ` utility to +Now you are ready to use :ref:`Project Wizard ` utility to launch the simulator.