docshund: a doc dog.
Project description
d o c s h u n d
simple code documentation generation
NOTE: Docshund is in alpha and is not yet suitable for production workloads. Please exercise caution when using.
Installation
pip3 install docshund
Usage
docshund code.py > documentation.md
What she do:
Go from this:
class Foo:
"""
This is a foo.
Do not cross the foo streams!
"""
def __init__(self):
"""
Create a new foo.
"""
def cross_streams(self, other_foo: Foo = None):
"""
Cross the streams of this foo with another foo.
If you do this, it will throw an error.
Arguments:
other_foo (Foo: None): The foo with which you'd like to cross streams
Returns:
None
Raises:
FooError: Raised if you cross the streams.
"""
if other_foo:
raise FooError("What did we JUST tell you?!")
To this markdown:
## *Class* `Foo`
This is a foo.
Do not cross the foo streams!
## *Function* `__init__(self)`
Create a new foo.
## *Function* `cross_streams(self, other_foo: Foo = None)`
Cross the streams of this foo with another foo.
If you do this, it will throw an error.
### Arguments
> - **other_foo** (`Foo`: `None`): The foo with which you'd like to cross streams
### Returns
None
### Raises
> - **FooError** (`None`: `None`): Raised if you cross the streams.
Class Foo
This is a foo.
Do not cross the foo streams!
Function __init__(self)
Create a new foo.
Function cross_streams(self, other_foo: Foo = None)
Cross the streams of this foo with another foo.
If you do this, it will throw an error.
Arguments
- other_foo (
Foo
:None
): The foo with which you'd like to cross streams
Returns
None
Raises
- FooError (
None
:None
): Raised if you cross the streams.
Generating documentation for this repository
The reference documentation for this repository was generated using the following command:
docshund docshund/__init__.py > docs/Reference.md
You might say we... 😎 ate our own dogfood.
Legal
Licensed under Apache 2.0. Reach out to opensource@fitmango.com with questions.
Copyright 2019 FitMango.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this codebase except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Made with ❤️ at 🥭
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for docshund-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 656c54c6c7db69ab76064d97e86698104fb7e85603a30afad4620599b0e66b3b |
|
MD5 | ac51a0cbed46221b0e828d66b6378593 |
|
BLAKE2b-256 | e107cff63f3c90f65c816bcc3f03be3a4e07d54ba9cb41dae15d8a12588b88e3 |