Pydoc: adding sections
up vote
1
down vote
favorite
I would like to improve the documentation of my python module with additional sections.
For example, let's consider this:
$ cat test.py
"""Some module
This stuff goes to the "DESCRIPTION" section.
"""
It will be rendered as follows:
$ pydoc test
Help on module test:
NAME
test - Some module
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
FILE
/tmp/tmp.XlLL4c82kb/test.py
Is there a way to have a SYNOPSYS section, where I can show some usage examples?
What I would like:
$ pydoc test
Help on module test:
NAME
test - Some module
SYNOPSYS
import test
test.foobar()
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
python pydoc
asked Nov 8 at 10:21
Dacav
6,72644466
add a comment |
up vote
1
down vote
favorite
I would like to improve the documentation of my python module with additional sections.
For example, let's consider this:
$ cat test.py
"""Some module
This stuff goes to the "DESCRIPTION" section.
"""
It will be rendered as follows:
$ pydoc test
Help on module test:
NAME
test - Some module
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
FILE
/tmp/tmp.XlLL4c82kb/test.py
Is there a way to have a SYNOPSYS section, where I can show some usage examples?
What I would like:
$ pydoc test
Help on module test:
NAME
test - Some module
SYNOPSYS
import test
test.foobar()
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
python pydoc
asked Nov 8 at 10:21
Dacav
6,72644466
add a comment |
up vote
1
down vote
favorite
up vote
1
down vote
favorite
I would like to improve the documentation of my python module with additional sections.
For example, let's consider this:
$ cat test.py
"""Some module
This stuff goes to the "DESCRIPTION" section.
"""
It will be rendered as follows:
$ pydoc test
Help on module test:
NAME
test - Some module
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
FILE
/tmp/tmp.XlLL4c82kb/test.py
Is there a way to have a SYNOPSYS section, where I can show some usage examples?
What I would like:
$ pydoc test
Help on module test:
NAME
test - Some module
SYNOPSYS
import test
test.foobar()
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
python pydoc
asked Nov 8 at 10:21
Dacav
6,72644466
I would like to improve the documentation of my python module with additional sections.
For example, let's consider this:
$ cat test.py
"""Some module
This stuff goes to the "DESCRIPTION" section.
"""
It will be rendered as follows:
$ pydoc test
Help on module test:
NAME
test - Some module
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
FILE
/tmp/tmp.XlLL4c82kb/test.py
Is there a way to have a SYNOPSYS section, where I can show some usage examples?
What I would like:
$ pydoc test
Help on module test:
NAME
test - Some module
SYNOPSYS
import test
test.foobar()
DESCRIPTION
This stuff goes to the "DESCRIPTION" section.
python pydoc
python pydoc
asked Nov 8 at 10:21
Dacav
6,72644466
asked Nov 8 at 10:21
Dacav
6,72644466
asked Nov 8 at 10:21
Dacav
6,72644466
asked Nov 8 at 10:21
Dacav
6,72644466
asked Nov 8 at 10:21
Dacav
6,72644466
6,72644466
add a comment |
add a comment |
active
oldest
votes
active
oldest
votes
active
oldest
votes
active
oldest
votes
active
oldest
votes
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53205723%2fpydoc-adding-sections%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
