Skip to content
Snippets Groups Projects
Commit fe4b2392 authored by ptangu01's avatar ptangu01
Browse files

fix bug code block

git-svn-id: https://redmine.imt-atlantique.fr/svn/xaal/code/Python/trunk@1325 b32b6428-25c9-4566-ad07-03861ab6144f
parent d596a97c
Branches
No related tags found
No related merge requests found
************************************
**********************************
README xAAL Python's documentation
************************************
**********************************
Introduction
============
......@@ -16,18 +16,16 @@ We are using the official theme of ReadTheDocs.
Consequently, download the package:
.. code:: bash
.. code-block:: bash
$ pip install sphinx_rtd_theme
In ``conf.py`` file (generated after a sphinx-quickstart for example):
.. code:: python
.. code-block:: python
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
......@@ -40,11 +38,10 @@ Build and Visualize
===================
To see your documentation locally you can do:
.. code:: bash
$ make build
$ cd build/html
$ python -m SimpleHTTPServer
.. code-block:: bash
Then open your favorite web browser and got to http://localhost:8000
$ make html
$ cd build/html
$ open build/html/index.html
......@@ -2,14 +2,46 @@
Contribute
==========
xAAL Python
-----------
Contributors are welcome.
If you want a read/write access on our svn:
.. bash:
.. code-block:: bash
$ svn co https://svn.telecom-bretagne.eu/repository/xAAL/code/Python
svn co https://svn.telecom-bretagne.eu/repository/xAAL/
Please contact us at:
xaal@mlistes.telecom-bretagne.eu
See Contact section to have more information to contact us.
Have a look to the "Contact" section to have more information to contact us.
Documentation
-------------
The documentation is generated with sphinx and we are using the official theme of ReadTheDocs.
To contribute, simply edit one of the file in the source directory.
Requirements
~~~~~~~~~~~~
We are using sphinx to generate the documentation and the official theme of ReadTheDocs.
To contribute to the xAAL Python's documentation you have to download the following packages:
.. code-block:: bash
$ pip install sphinx
$ pip install sphinx_rtd_theme
Build and Visualize
~~~~~~~~~~~~~~~~~~~
To see the documentation locally in your web browser:
.. code-block:: bash
$ cd docs
$ make html
$ open build/html/index.html
......@@ -22,9 +22,9 @@ or services. But some of them have ;-)
Firstly, you have to install the library xaal-lib:
.. bash::
.. code-block:: bash
$ cd xaal-lib
$ sudo python setup.py install (or develop)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment