Extended and converted developer guide to ReST

In order to include sphinx generated documentation, restructured text
has to be used. Added some sphinx generated content.

Signed-off-by: Claudius Heine <ch@denx.de>
This commit is contained in:
Claudius Heine 2017-06-28 14:48:50 +02:00 committed by Daniel Wagner
parent 67ec7f3bfc
commit 7ae7fcdb79
3 changed files with 107 additions and 55 deletions

View File

@ -32,4 +32,4 @@ Guides
------
- [User guide](docs/userguide.rst)
- [Developer guide](docs/devguide.md)
- [Developer guide](docs/devguide.rst)

View File

@ -1,54 +0,0 @@
Developer Guide
===============
Deploy for development
----------------------
This project uses pip to manage the package. If you want to work on the
project yourself you can create the necessary links via:
```sh
$ sudo pip3 install -e .
```
That will install a backlink /usr/bin/kas to this project. Now you are
able to call it from anywhere.
Docker image build
------------------
Just run
```sh
$ docker build -t <image_name> .
```
When you need a proxy to access the internet, add `--build-arg
http_proxy=<http_proxy> --build-arg https_proxy=<https_proxy>` to the
call.
Community Resources
-------------------
Project home:
- https://github.com/siemens/kas
Source code:
- https://github.com/siemens/kas.git
- git@github.com:siemens/kas.git
Mailing list:
- kas-devel@googlegroups.com
- Subscription:
- kas-devel+subscribe@googlegroups.com
- https://groups.google.com/forum/#!forum/kas-devel/join
- Archives
- https://groups.google.com/forum/#!forum/kas-devel
- https://www.mail-archive.com/kas-devel@googlegroups.com/

106
docs/devguide.rst Normal file
View File

@ -0,0 +1,106 @@
Developer Guide
===============
Deploy for development
----------------------
This project uses pip to manage the package. If you want to work on the
project yourself you can create the necessary links via::
$ sudo pip3 install -e .
That will install a backlink /usr/bin/kas to this project. Now you are
able to call it from anywhere.
Docker image build
------------------
Just run::
$ docker build -t <image_name> .
When you need a proxy to access the internet, add::
--build-arg http_proxy=<http_proxy> --build-arg https_proxy=<https_proxy>
to the call.
Community Resources
-------------------
Project home:
- https://github.com/siemens/kas
Source code:
- https://github.com/siemens/kas.git
- git@github.com:siemens/kas.git
Mailing list:
- kas-devel@googlegroups.com
- Subscription:
- kas-devel+subscribe@googlegroups.com
- https://groups.google.com/forum/#!forum/kas-devel/join
- Archives
- https://groups.google.com/forum/#!forum/kas-devel
- https://www.mail-archive.com/kas-devel@googlegroups.com/
Class reference documentation
-----------------------------
``kas.kas`` Module
..................
.. automodule:: kas.kas
:members:
``kas.libkas`` Module
.....................
.. automodule:: kas.libkas
:members:
``kas.libcmds`` Module
......................
.. automodule:: kas.libcmds
:members:
``kas.build`` Module
....................
.. automodule:: kas.build
:members:
``kas.shell`` Module
....................
.. automodule:: kas.shell
:members:
``kas.config`` Module
.....................
.. automodule:: kas.config
:members:
``kas.repos`` Module
....................
.. automodule:: kas.repos
:members:
``kas.includehandler`` Module
.............................
.. automodule:: kas.includehandler
:members: