mirror of
https://github.com/cve-search/pyvariot.git
synced 2024-11-23 15:27:22 +00:00
43 lines
742 B
ReStructuredText
43 lines
742 B
ReStructuredText
|
.. PyLookyloo documentation master file, created by
|
||
|
sphinx-quickstart on Tue Mar 23 12:28:17 2021.
|
||
|
You can adapt this file completely to your liking, but it should at least
|
||
|
contain the root `toctree` directive.
|
||
|
|
||
|
Welcome to PyProject's documentation!
|
||
|
=============================================
|
||
|
|
||
|
This is the client API for `PyProject <https://github.com/Lookyloo/project_template>`_:
|
||
|
|
||
|
foo
|
||
|
|
||
|
|
||
|
Installation
|
||
|
------------
|
||
|
|
||
|
The package is available on PyPi, so you can install it with::
|
||
|
|
||
|
pip install pyproject
|
||
|
|
||
|
|
||
|
Usage
|
||
|
-----
|
||
|
|
||
|
You can use `client` as a python script::
|
||
|
|
||
|
$ client -h
|
||
|
|
||
|
Or as a library:
|
||
|
|
||
|
.. toctree::
|
||
|
:glob:
|
||
|
|
||
|
api_reference
|
||
|
|
||
|
|
||
|
Indices and tables
|
||
|
==================
|
||
|
|
||
|
* :ref:`genindex`
|
||
|
* :ref:`modindex`
|
||
|
* :ref:`search`
|