Skip to content
Snippets Groups Projects
Commit 65ac399c authored by Robert Habermann's avatar Robert Habermann
Browse files

docs cont.

parent 2155b71c
No related branches found
No related tags found
No related merge requests found
......@@ -3,6 +3,14 @@ PyOTRS
[![build status](https://gitlab.denm.de/robbie/PyOTRS/badges/master/build.svg)](https://gitlab.denm.de/robbie/PyOTRS/commits/master)
Brief description..
Features
--------
- OTRS REST API for python
Import
------
......@@ -32,12 +40,14 @@ u'Welcome to OTRS!'
>>> my_ticket.to_dct() # Show complete ticket
- add an ``Article`` to ``Ticket`` with ID 1
>>> my_article = Article({"Subject": "Subj", "Body": "New Body"})
>>> client.ticket_update(1, article=my_article)
True
- get Articles and Attachments
>>> client.ticket_get_by_id(1, articles=1, attachments=1) # include Articles and Attachments
>>> my_ticket = client.result_list_ticket_get[0]
......@@ -57,13 +67,13 @@ Useful result data
Tips
----
**ipython**
```
import sys
reload(sys)
sys.setdefaultencoding('utf-8')
```
**ipython**::
import sys
reload(sys)
sys.setdefaultencoding('utf-8')
Full Docs
---------
......
Overview
========
Brief description..
Features
--------
* OTRS REST API for python
.. include:: ../README.rst
......@@ -14,3 +14,5 @@ tox -e docs
#sudo cp -a docs/build /var/www/PyOTRS/docs
sudo cp -a build/docs /var/www/PyOTRS/docs
# check format (README)
python setup.py check --strict --metadata --restructuredtext
......@@ -92,7 +92,7 @@ deps =
sphinx
sphinxcontrib-napoleon
sphinx_rtd_theme
pygments
commands =
sphinx-build -b html {toxinidir}/docs/ {toxinidir}/build/docs/
# sphinx-build -b html {toxinidir}/docs/ {toxinidir}/build/docs/
sphinx-build -b dirhtml {toxinidir}/docs/ {toxinidir}/build/docs/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment