Commit afb6851a authored by xa's avatar xa

better documentation

parent 1364cee8
Pipeline #907 passed with stages
in 3 minutes and 53 seconds
layout python
build:
docker build --tag aiodisque:latest .
documentation:
pip install -r docs/requirements.txt
cd docs && make html
......@@ -3,6 +3,9 @@ AIO Disque
Python3.5 & Asyncio client for Disque_ message broker.
Sources are available at https://lab.errorist.xyz/aio/aiodisque,
and mirrored at https://github.com/johnnoone/aiodisque.
Installation
------------
......
......@@ -113,7 +113,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
html_theme = 'irrational'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
......@@ -158,7 +158,9 @@ html_static_path = ['_static']
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
html_sidebars = {
'**': []
}
# Additional templates that should be rendered to pages, maps page names to
# template names.
......
AIODisque Getting started
=========================
Getting started
===============
Install from Pypi:
.. code-block:: shell
$ python -m pip install aiodisque
Then start to play with it:
Start to play with it:
.. code-block:: python
......@@ -45,7 +38,7 @@ iterators, queues and disque_:
async for job in client.jscan_iter(count=128):
print(job)
* There is also an experimentaton that try to mimic an asyncio.Queue::
* There is also an experimentaton that mimic an :ref:`asyncio.Queue`::
from aiodisque.queue import Queue
queue = JobsQueue('queue', client)
......
......@@ -10,15 +10,7 @@ AIO Disque is a modern client for Disque_ — an ongoing experiment to build a
distributed, in-memory, message broker — using Python coroutines and the
explicit async/await introduced in Python3.5.
Contents
--------
.. toctree::
:maxdepth: 1
getting-started
reference
Sources are available at https://lab.errorist.xyz/aio/aiodisque.
Installation
......@@ -49,11 +41,9 @@ AIO Disque tends to be 100% compatible with the disque api document.
It provides additional python goodies for queues and results iteration.
Indices and tables
==================
.. include:: getting-started.rst
* :ref:`genindex`
* :ref:`search`
.. include:: reference.rst
Documentation generated for version |version| and |release|.
......
.. py:module:: aiodisque
AIODisque Reference Manual
==========================
References
==========
This manual lists the basic functionality provided by aiodisque.
......
sphinx
-e git+https://lab.errorist.xyz/sphinx/irrational.git#egg=irrational
.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment