Skip to content

Commit 2e3fea6

Browse files
sebastinassebastinas
committed
Update documentation
TODO: dedent_after Signed-off-by: Sebastian Ramacher <sebastian+dev@ramacher.at>
1 parent 22f2aaa commit 2e3fea6

File tree

3 files changed

+81
-60
lines changed

3 files changed

+81
-60
lines changed

‎doc/sphinx/source/community.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ Community
44
=========
55
Do you need help with using bpython? Do you want to thank the contributors
66
personally? Or maybe you want to help out, contribute some code or resources
7-
or want to help in making bpython known to other persons?
7+
or want to help in making bpython known to other persons?
88

99
These are the places where you can find us.
1010

1111
IRC
1212
---
13-
You can find us in #bpython on the Freenode network (irc.freenode.net). Don't
14-
worry when you get no response (this does not usually happen) but we are all
15-
from Europe and when you get to the channel during our nighttime you might have
16-
to wait a while for a response.
13+
You can find us in `#bpython <irc://irc.freenode.net/bpython>`_ on the `Freenode
14+
<http://freenode.net>`_ network. Don't worry when you get no response (this does
15+
not usually happen) but we are all from Europe and when you get to the channel
16+
during our nighttime you might have to wait a while for a response.
1717

1818
Mailing List
1919
------------
20-
We have a mailing list at `google groups <http://groups.google.com/group/bpython>`_.
21-
You can post questions there and releases are announced on the mailing
22-
list.
20+
We have a mailing list at `google groups
21+
<http://groups.google.com/group/bpython>`_. You can post questions there and
22+
releases are announced on the mailing list.
2323

2424
Website
2525
-------

‎doc/sphinx/source/configuration-options.rst

Lines changed: 70 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@ General
33
This refers to the ``[general]`` section in your
44
`$XDG_CONFIG_HOME/bpython/config` file.
55

6+
arg_spec
7+
^^^^^^^^
8+
Display the arg spec (list of arguments) for callables, when possible (default:
9+
True).
10+
611
auto_display_list
712
^^^^^^^^^^^^^^^^^
813
Display the autocomplete list as you type (default: True).
@@ -16,48 +21,59 @@ subsequence, and fuzzy matches methods with common characters (default: simple).
1621

1722
.. versionadded:: 0.12
1823

19-
syntax
24+
.. _configuration_color_scheme:
25+
26+
color_scheme
27+
^^^^^^^^^^^^
28+
See :ref:`themes` for more information.
29+
30+
Color schemes should be put in ``$XDG_CONFIG_HOME/bpython/``. For example, to
31+
use the theme ``$XDG_CONFIG_HOME/bpython/foo.theme`` set ``color_scheme = foo``
32+
33+
Leave blank or set to "default" to use the default (builtin) theme.
34+
35+
complete_magic_methods
36+
^^^^^^^^^^^^^^^^^^^^^^
37+
Whether magic methods should be auto completed (default: True).
38+
39+
dedent_after
40+
^^^^^^^^^^^^
41+
TODO (default: 1)
42+
43+
editor
2044
^^^^^^
21-
Syntax highlighting as you type (default: True).
45+
Editor for externally editing the current line.
2246

23-
arg_spec
24-
^^^^^^^^
25-
Display the arg spec (list of arguments) for callables, when possible (default:
26-
True).
47+
.. versionadded:: 0.13
48+
49+
flush_output
50+
^^^^^^^^^^^^
51+
Whether to flush all output to stdout on exit (default: True).
52+
53+
highlight_show_source
54+
^^^^^^^^^^^^^^^^^^^^^
55+
Whether the source code of an object should be highlighted (default: True).
56+
57+
hist_duplicates
58+
^^^^^^^^^^^^^^^
59+
Whether to store duplicate entries in the history (default: True).
2760

2861
hist_file
2962
^^^^^^^^^
3063
History file (default: ``~/.pythonhist``).
3164

32-
paste_time
33-
^^^^^^^^^^
34-
The time between lines before pastemode is activated in seconds (default: 0.02).
35-
3665
hist_length
3766
^^^^^^^^^^^
3867
Number of lines to store in history (set to 0 to disable) (default: 100).
3968

40-
tab_length
69+
paste_time
4170
^^^^^^^^^^
42-
Soft tab size (default 4, see pep-8)
43-
44-
pastebin_url
45-
^^^^^^^^^^^^
46-
The pastebin url to post to (without a trailing slash). This pastebin has to be
47-
a pastebin which uses provides a similar interface to ``bpaste.net``'s JSON
48-
interface (default: https://bpaste.net/json/new).
49-
50-
pastebin_show_url
51-
^^^^^^^^^^^^^^^^^
52-
The url under which the new paste can be reached. ``$paste_id`` will be replaced
53-
by the ID of the new paste (default: https://bpaste.net/show/$paste_id/).
54-
55-
pastebin_removal_url
56-
^^^^^^^^^^^^^^^^^^^^
57-
The url under which a paste can be removed. ``$removal_id`` will be replaced by
58-
the removal ID of the paste (default: https://bpaste.net/remova/$removal_id/).
71+
The time between lines before pastemode is activated in seconds (default: 0.02).
5972

60-
.. versionadded:: 0.14
73+
pastebin_confirm
74+
^^^^^^^^^^^^^^^^
75+
Whether pasting to a pastebin needs to be confirmed before sending the data
76+
(default: True).
6177

6278
pastebin_expiry
6379
^^^^^^^^^^^^^^^
@@ -120,41 +136,45 @@ following helper program can be used to create `gists
120136
121137
.. versionadded:: 0.12
122138

139+
pastebin_show_url
140+
^^^^^^^^^^^^^^^^^
141+
The url under which the new paste can be reached. ``$paste_id`` will be replaced
142+
by the ID of the new paste (default: https://bpaste.net/show/$paste_id/).
123143

124-
single_undo_time
125-
^^^^^^^^^^^^^^^^
126-
Time duration an undo must be predicted to take before prompting
127-
to undo multiple lines at once. Use -1 to never prompt, or 0 to always prompt.
128-
(default: 1.0)
144+
pastebin_removal_url
145+
^^^^^^^^^^^^^^^^^^^^
146+
The url under which a paste can be removed. ``$removal_id`` will be replaced by
147+
the removal ID of the paste (default: https://bpaste.net/remova/$removal_id/).
129148

130149
.. versionadded:: 0.14
131150

132-
.. _configuration_color_scheme:
133-
134-
color_scheme
135-
^^^^^^^^^^^^
136-
See :ref:`themes` for more information.
137-
138-
Color schemes should be put in ``$XDG_CONFIG_HOME/bpython/``. For example, to
139-
use the theme ``$XDG_CONFIG_HOME/bpython/foo.theme`` set ``color_scheme = foo``
140-
141-
Leave blank or set to "default" to use the default (builtin) theme.
142-
143-
flush_output
151+
pastebin_url
144152
^^^^^^^^^^^^
145-
Whether to flush all output to stdout on exit (default: True).
153+
The pastebin url to post to (without a trailing slash). This pastebin has to be
154+
a pastebin which uses provides a similar interface to ``bpaste.net``'s JSON
155+
interface (default: https://bpaste.net/json/new).
146156

147157
save_append_py
148158
^^^^^^^^^^^^^^
149159
Whether to append ``.py`` to the filename while saving the input to a file.
150160

151161
.. versionadded:: 0.13
152162

153-
editor
163+
single_undo_time
164+
^^^^^^^^^^^^^^^^
165+
Time duration an undo must be predicted to take before prompting
166+
to undo multiple lines at once. Use -1 to never prompt, or 0 to always prompt.
167+
(default: 1.0)
168+
169+
.. versionadded:: 0.14
170+
171+
syntax
154172
^^^^^^
155-
Editor for externally editing the current line.
173+
Syntax highlighting as you type (default: True).
156174

157-
.. versionadded:: 0.13
175+
tab_length
176+
^^^^^^^^^^
177+
Soft tab size (default 4, see PEP-8).
158178

159179
unicode_box
160180
^^^^^^^^^^^

‎doc/sphinx/source/contributing.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ these are particularly good ones to start out with.
1010

1111
See our section about the :ref:`community` for a list of resources.
1212

13-
`#bpython` on freenode is particularly useful, but you might have to wait for a
14-
while to get a question answered depending on the time of day.
13+
`#bpython <irc://irc.freenode.net/bpython>`_ on Freenode is particularly useful,
14+
but you might have to wait for a while to get a question answered depending on
15+
the time of day.
1516

1617
Getting your development environment set up
1718
-------------------------------------------

0 commit comments

Comments
 (0)