Skip to content

Commit

Permalink
Update doc [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
pfernique committed Oct 5, 2017
1 parent 6ccf34b commit 241f61a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 20 deletions.
19 changes: 0 additions & 19 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Installation
.. toctree::
:maxdepth: 2

install/docker
install/anaconda
install/source

Expand All @@ -39,26 +38,8 @@ Documentation
user_guide
examples/index
faq/index


License
=======

**AutoWIG** is distributed under the |LICENSENAME|_.

.. note::

|LICENSENAME| is LGPL compatible.

Authors
=======

.. include:: ../AUTHORS.rst

.. |LICENSENAME| replace:: CeCILL license

.. _LICENSENAME : license.html

.. |LICENSE| replace:: see `License`_ section

.. |AUTHORS| replace:: see `Authors`_ section
2 changes: 1 addition & 1 deletion doc/install/anaconda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Once **Conda** is installed, you can install **AutoWIG** binaries into a special

.. code-block:: console
$ conda create -n autowig python-autowig python-clanglite python-scons python-dev libdev -c statiskit -c conda-forge
conda create -n autowig python-autowig -c statiskit
.. warning::

Expand Down
21 changes: 21 additions & 0 deletions doc/install/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,24 @@ Installation from source code
=============================

For installing **AutoWIG** from source code, please refers to the **StatisKit** `documentation <https://statiskit.rtfd.io>`_ concerning the configuration of the development environment.

.. warning::

**AutoWIG** and **ClangLite** repositories are considered as submodule of the **StatisKit** repository.
To update these repositories and benefit from the last development, you must first go to these submodules and pull the code from the actual repositories.
This step, described below, has to be as soon as the **StatisKit** repository is cloned.

.. code-block:: bash
cd StatisKit
cd share
cd git
cd ClangLite
git pull
cd ..
cd AutoWIG
git pull
cd ..
cd ..
cd ..

0 comments on commit 241f61a

Please sign in to comment.