A pypi demonstration vehicle.
This is something I want to say that is not in the docstring.
Platforms:Unix, Windows
We use this as a public class example class.
You never call this class before callingpublic_fn_with_sphinxy_docstring().
Note
An example of intersphinx is this: youcannot usepickle on this class.
This gets the foobar
This really should have a full function definition, but I am too lazy.
>>>printget_foobar(10,20)30>>>printget_foobar('a','b')ab
Isn’t that what you want?
This function does something.
int. The return code:
0 -- Success!1 -- No good. 2 -- Try again.
A really great idea. A way you might use me is
>>>printpublic_fn_with_googley_docstring(name='foo',state=None)0
BTW, this always returns 0.NEVER use withMyPublicClass.
This function does something.
| Parameters: |
|
|---|---|
| Returns: | int – the return code. |
| Raises: | AttributeError, KeyError |
This is something I want to say that is not in the docstring.
A very useful module indeed.
This function does something.
| Parameters: |
|
|---|---|
| Returns: | int – the return code. |
| Raises: | AttributeError, KeyError |
We use this as a public class example class.
You never call this class before callingpublic_fn_with_sphinxy_docstring().
Note
An example of intersphinx is this: youcannot usepickle on this class.
This gets the foobar
This really should have a full function definition, but I am too lazy.
>>>printget_foobar(10,20)30>>>printget_foobar('a','b')ab
Isn’t that what you want?
A private function to get baz.
This really should have a full function definition, but I am too lazy.
Getting Started Withsetuptools andsetup.py
Building and Uploading Your Sphinx Docs to pypi
Enter search terms or a module, class or function name.