Giter VIP home page Giter VIP logo

mysql-workbench-html-doc-generator's Introduction

MySQL Workbench HTML Document Generation

A Python script to generate HTML documentation from MySQL Workbench ERR diagram. Original version for generating Markdown-docs from models by Hieu Le Trung you find here.

Installation

  • Download the latest version from Github
  • Extract the downloaded file and find a file named d1-diagram-html-doc-generator.py
  • Open the MySQL Workbench
  • Navigate to menu Scripting > Install Plugin/Module...
  • Browse and select the extracted .py file
  • Restart the Workbench

Usage

Generate documentation from diagram

  • Open the ERR digram
  • Navigate to menu Tools > Utilities > Generate Documentation (HTML)
  • When you see the status bar text changed to Documentation generated into the clipboard. Paste it to your editor., Paste (Ctrl + V in most Linux/Window applications) to your editor and save as a new file.

Generate ERR digram from physical database

In case that you do not have the ERR diagram, you have to create a diagram from your physical database first. Don't worry, MySQL Workbench has a greate tool to do this for you called Reverse Engineer.

  • Open Workbench
  • Navigate to menu Database > Reverse Engineer...
  • Choose the connection, Next
  • Wait and Next
  • Select the datbase you want to create ERR diagram from, Next
  • Wait and Next
  • Select tables that you want to include in the ERR diagram, Execute>
  • Wait and Next
  • Finish

You have a new ERR diagram, you can generate the documentation from this diagram as the previous step.

Features

  • Autogenerating contents.
  • Autogenerating anchors from FKs to tables.
  • Tables and columns description generates from comments.

License

This script is released under the MIT license. Original description by Hieu Le Trung.

mysql-workbench-html-doc-generator's People

Contributors

d1soft avatar garr1nch4 avatar

Stargazers

 avatar  avatar

Forkers

akosukhin001

mysql-workbench-html-doc-generator's Issues

Getting an error while invoking the utility

Hi

I have installed the script and when I am trying to invoke the utility I am getting this error: "error calling python module function ModelHtmlDocumentation.documentation

image

May you please help to resolve the same. I am using Mysql workbench 8.0.15

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.