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

clean up docs

parent 0f01e923
No related branches found
No related tags found
No related merge requests found
File moved
File moved
Getting Started
===============
Get Started:
Get Started::
from pyotrs import Client
client = Client("https://otrs.example.com", "GenericTicketConnectorREST", "root@localhost", "x")
client.session_restore_or_set_up_new()
client.ticket_get_by_id(1)
from pyotrs import Client
client = Client("https://otrs.example.com", "GenericTicketConnectorREST", "root@localhost", "x")
client.session_restore_or_set_up_new()
client.ticket_get_by_id(1)
PyOTRS documentation
====================
Brief description..
**Features:**
* OTRS REST API for python
.. toctree::
:maxdepth: 2
:caption: Introduction
......@@ -27,5 +21,5 @@ Brief description..
pyotrs_public
pyotrs
changelog
contributing
changelog_pandoc
contributing_pandoc
......@@ -9,10 +9,10 @@ Project is not yet hosted on Pypi - so for now get it here::
wget https://sys.denm.de/PyOTRS/dist/PyOTRS-0.3.0.tar.gz
Dependencies*
-------------
Dependencies
------------
*\*installed automatically*
*Dependencies are installed automatically*
* python-requests
* click (for CLI App)
......
Overview
========
Brief description..
Features
--------
* OTRS REST API for python
Toc
---
"""
.. moduleauthor:: Robert Habermann <robert.habermann@dlh.de>
.. autosummary::
This is PyOTRS provide python access to OTRS
Warm welcome words
Foo
Bar
Kernel::GenericInterface::Operation GenericInterface Operation interface
Kernel::GenericInterface::Operation
Common Base class for all Operations
Session::Common Base class for Session Operations
Session::SessionCreate GenericInterface Session Create Operation backend
Test::Test GenericInterface Operation Test backend
Ticket::Common Base class for all Ticket Operations
Ticket::TicketCreate GenericInterface Ticket TicketCreate Operation backend
Ticket::TicketGet GenericInterface Ticket Get Operation backend
Ticket::TicketSearch GenericInterface Ticket Search Operation backend
Ticket::TicketUpdate GenericInterface Ticket TicketUpdate Operation backend
""" This is PyOTRS provide python access to OTRS
.. note::
......
......@@ -109,9 +109,8 @@ basepython =
commands =
rm -rf {toxinidir}/docs/build
pandoc -f markdown -t rst -o {toxinidir}/docs/source/changelog.txt CHANGELOG.md
pandoc -f markdown -t rst -o {toxinidir}/docs/source/contributing.txt CONTRIBUTING.md
pandoc -f markdown -t rst -o {toxinidir}/docs/source/changelog_pandoc.txt CHANGELOG.md
pandoc -f markdown -t rst -o {toxinidir}/docs/source/contributing_pandoc.txt CONTRIBUTING.md
sphinx-build -b html {toxinidir}/docs/source {toxinidir}/docs/build
sudo rm -rf /var/www/PyOTRS/docs/
sudo mkdir /var/www/PyOTRS/docs
sudo cp -a docs/build/* /var/www/PyOTRS/docs/
sudo rm -rf /var/www/PyOTRS/docs
sudo cp -a {toxinidir}/docs/build /var/www/PyOTRS/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