Skip to content

teamdigitale/sphinxcontrib-httpspec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sphinx extension that provide inlines references to HTTP specs

Installation

pip install git+https://github.com/teamdigitale/sphinxcontrib-httpspec

Add sphinxcontrib.httpspec to extensions in your conf.py.

Usage

Whenever you want to reference an http component defined in the specs, use the roles in the rST source of your documentation like this:

On success, you should return :httpstatus:`200` and 
use the :httpheader:`Location` to reference the returned resource.

This will point to:

Supported roles:

  • :httpheader:
  • :httpstatus:
  • :httpmethod:

Licenses

BSD-3-Clause.

About

Roles referencing specs for http from mozilla website

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages