Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

inkpot

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

inkpot

a small simple library for generating documentation from docstrings

  • 2.2.7
  • PyPI
  • Socket score

Maintainers
1

inkpot

A small simple library for generating documentation from docstrings

inkpot is available on pip. Please give it a star if you like it!

drawing

GitHub stars GitHub forks Tweet

GitHub PyPI PyPI - Python Version PyPI - Downloads

To know more about way this project was started, checkout this blog post.

Installation

pip install inkpot

Usage

single file

python3 -m inkpot myfile.py

or directory

python3 -m inkpot myproject/

output to a file (also works with directories)

python3 -m inkpot myfile.py > doc.md
python3 -m inkpot myproject/ > doc.md

More functionality and better formatting might be added.

Example

On the wiki you can se the result of running inkpot on the inkpot source code.

Here is a small example from the test files.

Python file tests/.ex/add.py

def add(a,b):
    """ add to objects """
    return a + b

python3 -m inkpot tests/.ex/add.py

returns markdown

# tests/.ex/add.py
## tests/.ex/add.py
**def add(a, b)** \
`add to objects `

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgement

A special thanks to:

  • Astunparse, which is used in inkpot to unparse python files

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc