https://github.com/janbrohl/sphinxcontrib-sqldomain

A Sphinx Domain for SQL databases
https://github.com/janbrohl/sphinxcontrib-sqldomain

sphinx sphinx-doc sphinx-extension

Last synced: 2 months ago
JSON representation

A Sphinx Domain for SQL databases

• Host: GitHub
• URL: https://github.com/janbrohl/sphinxcontrib-sqldomain
• Owner: janbrohl
• License: bsd-3-clause
• Created: 2019-06-15T08:47:45.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-06-15T20:25:59.000Z (almost 6 years ago)
• Last Synced: 2025-01-22T20:51:35.772Z (4 months ago)
• Topics: sphinx, sphinx-doc, sphinx-extension
• Language: Python
• Size: 16.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=======================

sphinxcontrib-sqldomain

=======================

.. image:: https://travis-ci.org/janbrohl/sphinxcontrib-sqldomain.svg?branch=master

    :target: https://travis-ci.org/janbrohl/sphinxcontrib-sqldomain

Sphinx Domain for documenting SQL databases

Help Welcome

------------

As you can possibly see, this project is currently in early planning - no actual code yet.

If you have ideas/whishes or see problems I would be glad to see your comments.

Overview

--------

This Domain will contain Directives for:

- Database

- Schema

- Table

- View

- Column

- Type

- Procedure

- Index

- Constraint

- Primary Key

- Grant

- User

- Group/Layer (undecided)

- Something for rendering overviews and summaries.

Links

-----

- Source: https://github.com/janbrohl/sphinxcontrib-sqldomain

- Bugs: https://github.com/janbrohl/sphinxcontrib-sqldomain/issues