All Projects → viniciuschiele → Flask Apidoc

viniciuschiele / Flask Apidoc

Licence: mit
Adds ApiDoc support to Flask

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to Flask Apidoc

Parse Comments
Parse JavaScript code comments. Works with block and line comments, and should work with CSS, LESS, SASS, or any language with the same comment formats.
Stars: ✭ 53 (+8.16%)
Mutual labels:  apidoc, documentation, docs
Docnado
Rapid documentation tool that will blow you away...
Stars: ✭ 67 (+36.73%)
Mutual labels:  documentation, docs, flask
Flask Blogging
A Markdown Based Python Blog Engine as a Flask Extension.
Stars: ✭ 609 (+1142.86%)
Mutual labels:  flask, flask-extensions
Website
🌐 The Babel documentation website
Stars: ✭ 631 (+1187.76%)
Mutual labels:  documentation, docs
Flask Apscheduler
Adds APScheduler support to Flask
Stars: ✭ 741 (+1412.24%)
Mutual labels:  flask, flask-extensions
App
Fast and searchable Ruby docs
Stars: ✭ 47 (-4.08%)
Mutual labels:  documentation, docs
Bluedoc
An open-source document management tool for enterprise self host.
Stars: ✭ 579 (+1081.63%)
Mutual labels:  documentation, docs
Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+55426.53%)
Mutual labels:  documentation, docs
Docz
✍ It has never been so easy to document your things!
Stars: ✭ 22,020 (+44838.78%)
Mutual labels:  documentation, docs
Parse Code Context
Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype properties, prototype methods etc.
Stars: ✭ 7 (-85.71%)
Mutual labels:  documentation, docs
Documentation
Documentation for the STUPS ecosystem
Stars: ✭ 18 (-63.27%)
Mutual labels:  documentation, docs
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (+1640.82%)
Mutual labels:  documentation, docs
Flask Googlemaps
Easy way to add GoogleMaps to Flask applications. maintainer: @RiverFount
Stars: ✭ 550 (+1022.45%)
Mutual labels:  flask, flask-extensions
Circleci Docs
Documentation for CircleCI.
Stars: ✭ 501 (+922.45%)
Mutual labels:  documentation, docs
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (+1132.65%)
Mutual labels:  documentation, docs
Potion
Flask-Potion is a RESTful API framework for Flask and SQLAlchemy, Peewee or MongoEngine
Stars: ✭ 484 (+887.76%)
Mutual labels:  flask, flask-extensions
Docs
Documentation of Vercel and other services
Stars: ✭ 663 (+1253.06%)
Mutual labels:  documentation, docs
Bsdoc
📚 Documentation Generator for BuckleScript
Stars: ✭ 43 (-12.24%)
Mutual labels:  documentation, docs
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (+802.04%)
Mutual labels:  documentation, docs
Ru.reactjs.org
React documentation website in Russian / Официальная русская версия сайта React
Stars: ✭ 444 (+806.12%)
Mutual labels:  documentation, docs

================================= Flask ApiDoc

Flask ApiDoc is a Flask extension which adds support for the ApiDoc_.

|Version|

Features

  • Flask-Script command to generate the apidoc's files, by default they are generated into static/docs
  • Host apidoc's files, by default they are hosted in http://localhost:5000/docs
  • Replace the base URL for the endpoints by the current Flask URL.
  • Allow absolute urls in @api

Documentation

Soon... take a look at the example_ to see how it works.

Installation

You can install flask-apidoc via Python Package Index (PyPI_),::

$ pip install flask-apidoc

Feedback

Please use the Issues_ for feature requests and troubleshooting usage.

.. |Version| image:: https://badge.fury.io/py/flask-apidoc.svg :target: http://badge.fury.io/py/flask-apidoc

.. _ApiDoc: http://www.apidocjs.com

.. _example: https://github.com/viniciuschiele/flask-apidoc/tree/master/example

.. _PyPi: https://pypi.python.org/pypi/flask-apidoc

.. _Issues: https://github.com/viniciuschiele/flask-apidoc/issues

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].