2015-01-14 00:05:26 +00:00
|
|
|
Development
|
|
|
|
|
############
|
|
|
|
|
|
|
|
|
|
Code convention
|
|
|
|
|
===============
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Respect all the PEP8 convention except the max line length rule.
|
2015-01-14 00:05:26 +00:00
|
|
|
|
2016-06-21 08:47:22 +00:00
|
|
|
Source code
|
|
|
|
|
===========
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
Source code is available on Github under the GPL V3 licence:
|
2016-06-21 08:47:22 +00:00
|
|
|
https://github.com/GNS3/
|
|
|
|
|
|
|
|
|
|
The GNS3 server: https://github.com/GNS3/gns3-server
|
2018-01-31 16:37:02 +00:00
|
|
|
The GNS3 user interface: https://github.com/GNS3/gns3-gui
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2015-01-14 00:05:26 +00:00
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
|
==============
|
|
|
|
|
|
2018-01-31 16:37:02 +00:00
|
|
|
The documentation can be found in the gns3-server project.
|
2016-06-21 08:47:22 +00:00
|
|
|
|
2015-01-14 00:05:26 +00:00
|
|
|
Build doc
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
|
|
2015-01-23 15:20:12 +00:00
|
|
|
./scripts/documentation.sh
|
2015-01-14 00:05:26 +00:00
|
|
|
|
|
|
|
|
The output is available inside *docs/_build/html*
|
|
|
|
|
|
|
|
|
|
Tests
|
|
|
|
|
======
|
|
|
|
|
|
|
|
|
|
Run tests
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
.. code-block:: bash
|
|
|
|
|
|
|
|
|
|
py.test -v
|
