pencil-pusher

A python package that compiles source documentation and publishes it to the repo wiki


Keywords
python, wiki, documentation-tool
License
MIT
Install
pip install pencil-pusher==1.6.1

Documentation

📝 pencil_pusher

A Github Action that creates and publishes source documentation to the repository's wiki. THIS IS NOT A DOCUMENTATION GENERATION TOOL. This tool is designed to take pre-generated documentation and publish it to a the source repository's github wiki page. This removes the need to host a webpage for documentation and allows for an easy way to include documentation generation in your CI/CD pipeline. To get started using this action in your repository check out the General Usage page of our wiki.

Tech Stack

this project uses snake-charmer for automatic releases