Skip to content

Create documentation for your API in HTML format just by running integration tets

Notifications You must be signed in to change notification settings

AndreaCrotti/django-docs-from-tests

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Django docs from tests

This project will allow to generate some useful documentation about your API, just from the tests. Your tests are basically the contract between the clients and the API, so nothing is more reliable then them.

How to make it work

  • first set up your project to use django-nose (might be optional in the future
  • run the tests passing an extra option --docs-gen

About

Create documentation for your API in HTML format just by running integration tets

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages