Skip to content

Commit e39e83d

Browse files
committed
Merge remote-tracking branch 'refs/remotes/origin/master' into latofont
2 parents b89d1e3 + 219d877 commit e39e83d

File tree

17 files changed

+709
-809
lines changed

17 files changed

+709
-809
lines changed

demo_docs/source/__init__.py

Whitespace-only changes.

demo_docs/source/api.rst

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,48 @@
1+
2+
*********************
13
:mod:`test_py_module`
2-
=====================
4+
*********************
5+
6+
.. contents:: Table of Contents
37

48
.. automodule:: test_py_module.test
59
:members:
610
:private-members:
711
:special-members:
12+
13+
14+
Optional parameter args
15+
=======================
16+
17+
At this point optional parameters `cannot be generated from code`_.
18+
However, some projects will manually do it, like so:
19+
20+
This example comes from `django-payments module docs`_.
21+
22+
.. class:: payments.dotpay.DotpayProvider(seller_id, pin[, channel=0[, lock=False], lang='pl'])
23+
24+
This backend implements payments using a popular Polish gateway, `Dotpay.pl <http://www.dotpay.pl>`_.
25+
26+
Due to API limitations there is no support for transferring purchased items.
27+
28+
29+
:param seller_id: Seller ID assigned by Dotpay
30+
:param pin: PIN assigned by Dotpay
31+
:param channel: Default payment channel (consult reference guide)
32+
:param lang: UI language
33+
:param lock: Whether to disable channels other than the default selected above
34+
35+
.. _cannot be generated from code: https://groups.google.com/forum/#!topic/sphinx-users/_qfsVT5Vxpw
36+
.. _django-payments module docs: http://django-payments.readthedocs.org/en/latest/modules.html#payments.authorizenet.AuthorizeNetProvide
37+
38+
39+
Data
40+
====
41+
42+
.. data:: Data_item_1
43+
Data_item_2
44+
Data_item_3
45+
46+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce congue elit eu hendrerit mattis.
47+
48+
Some data link :data:`Data_item_1`.

demo_docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
# All configuration values have a default; values that are commented out
1212
# serve to show the default.
1313

14-
import sys, os
14+
import sys
15+
import os
1516

1617
sys.path.append(os.path.abspath('.'))
1718
sys.path.append(os.path.abspath('./test_py_module'))

0 commit comments

Comments
 (0)