Write docstrings in Markdown!
Project description
inari
Write docstrings in Markdown!
Features
- Minimum configuration.
- No dependencies by default(but MkDocs is recommended!).
- CLI and MkDocs Plugin.
- Cross reference in API documents.
Install
pip install inari[mkdocs]
Example
# sample.py
"""This is a sample module."""
variable = 42
"""(`int`): Docstrings for module-level variables."""
def func(foo: str, bar: int) -> str:
"""
Docstrings for functions.
**Args**
* foo (`str`): First argument.
* bar (`int`): Second argument.
**Returns**
* `str`: Type of return value.
"""
return foo * bar
class SampleClass:
"""
Class docstrings.
**Attributes**
* baz (`str`): Docstrings for attributes.
"""
baz: str
def __init__(self, b: str):
"""
**Args**
* b (`str`): Arguments for initializing.
"""
self.baz = b
def method(self, bar: int) -> str:
"""
Method docstrings.
Cross reference available. `sample.func`
**Args**
* bar(`int`)
**Returns**
* `str`
"""
return func(self.baz, bar)
inari sample docs
inari
makes this Markdown file:
<!-- docs/sample-py.md -->
# Module sample
This is a sample module.
## Variables
- **variable**{: #variable } (`int`): Docstrings for module-level variables.
## Classes
### SampleClass {: #SampleClass }
```python
class SampleClass(self, b: str)
```
Class docstrings.
**Attributes**
- **baz** (`str`): Docstrings for attributes.
**Args**
- **b** (`str`): Arguments for initializing.
---
#### Methods {: #SampleClass-methods }
[**method**](#SampleClass.method){: #SampleClass.method }
```python
def method(self, bar: int) -> str
```
Method docstrings.
Cross reference available. [`func `](#func)
**Args**
- **bar** (`int`)
**Returns**
- `str`
## Functions
### func {: #func }
```python
def func(foo: str, bar: int) -> str
```
Docstrings for functions.
**Args**
- **foo** (`str`): First argument.
- **bar** (`int`): Second argument.
**Returns**
- `str`: Type of return value.
License
MIT
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
inari-0.2.1.tar.gz
(11.6 kB
view details)
Built Distribution
inari-0.2.1-py3-none-any.whl
(12.5 kB
view details)
File details
Details for the file inari-0.2.1.tar.gz
.
File metadata
- Download URL: inari-0.2.1.tar.gz
- Upload date:
- Size: 11.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.4.0-77-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f0974db2fe64403f2a2d43a4484c194db48f4b76b366c70324b604f309f9eed |
|
MD5 | d645764d43dc390fdf435c66861ed4a3 |
|
BLAKE2b-256 | 75d0267f01e102665f5858d748154205da2152042b94fd2ab852ccc21ffbe177 |
File details
Details for the file inari-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: inari-0.2.1-py3-none-any.whl
- Upload date:
- Size: 12.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.7 CPython/3.9.6 Linux/5.4.0-77-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | edda3334e07125c38221f53a5fb0a6ab6e98948f9c6c156a7e2f7bc4907c5d5d |
|
MD5 | 99af8a3dd07fb5d9200548a471fe44e1 |
|
BLAKE2b-256 | d56086478ee94ebe40a67ac5ff5f2ebd5f0900f896b0855de679244b1958f96e |