doc/index.rst

Fri, 18 May 2018 00:04:18 +0200

author
David Douard <david.douard@logilab.fr>
date
Fri, 18 May 2018 00:04:18 +0200
changeset 93
b459d4bc07cf
parent 92
e3ed554038fa
child 95
c6b655d9b855
permissions
-rw-r--r--

[setup] improve setup a bit

- comment section
- include descriptions
- add several setup() args

92
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
1 .. pygpibtoolkit documentation master file, created by
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
2 sphinx-quickstart on Wed May 16 10:51:57 2018.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
4 contain the root `toctree` directive.
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
5
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
6 Welcome to pygpibtoolkit's documentation!
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
7 =========================================
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
8
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
9 .. toctree::
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
10 :maxdepth: 2
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
11 :caption: Contents:
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
12
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
13 introduction
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
14 developer_manual
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
15
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
16
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
17 Indices and tables
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
18 ==================
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
19
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
20 * :ref:`genindex`
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
21 * :ref:`modindex`
e3ed554038fa convert doc to sphinx
David Douard <david.douard@logilab.fr>
parents:
diff changeset
22 * :ref:`search`

mercurial