Skip to main content

RFC2119 directives for Sphinx documentation

Project description

The purpose of this sphinx extension is enable markup of requirements per the definitions in RFC 2119.

This is supported by a suite of requirement directives that correspond to the RFC 2119 keywords. There are also a suite of requirement list directives that support documenting reqiurements (that have been defined with the rfc2119 directives).

This module is in ALPHA status. Feedback / pull requests very welcome. Development occurs on GitHub:

Documentation is a bit strange - I used the directives to document what it is supposed to do. Which was handy as I made it, but probably not very readable.

Basically, add the module to your the conf.py of your repo then use the directives. They have lower case names.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_rfc2119-0.0.10.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file sphinx_rfc2119-0.0.10.tar.gz.

File metadata

File hashes

Hashes for sphinx_rfc2119-0.0.10.tar.gz
Algorithm Hash digest
SHA256 ba15879e0538f7b48d501fb5cc09975a73e90b77fab2ae4e2f8e4bc795cc6bfc
MD5 b02e12dccbf597d9cf3605b9e94ee217
BLAKE2b-256 5d0de4bc60b78d3e042b8dca548619fc7aaec8751b9ca20ca01ca6437ad18464

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page