Project

pg-doc

0.0
No commit activity in last 3 years
No release in over 3 years
Automatic documentation for your PostgreSQL database
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

~> 1.16
>= 0
~> 10.0

Runtime

~> 1.0
~> 3.4
~> 2.0
 Project Readme

PG::Doc

Gem Version Build Status Dependency Status

This gem is under initial development. 0.1.0 will be the first release.

Installation

Add this line to your application's Gemfile:

gem 'pg-doc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pg-doc

To Do

  • Document usage
  • Document mount PG::Doc::Web(url, options)
  • Document :schema_filter option
  • Create and document caching to disk via marshal
  • Create and document the markdown folder structure
  • Write UI

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kenaniah/pg-doc.