Skip to content
Sections
>> Trisquel >> Packages >> nabia >> python >> python3-os-api-ref
[  etiona  ] [  nabia  ] [  aramo  ]
[ Source: python-os-api-ref  ]

Package: python3-os-api-ref (2.0.1-0ubuntu1)

Sphinx Extensions to support API reference sites in OpenStack - Python 3.x

This project is a collection of sphinx stanzas that assist in building an API Reference site for an OpenStack project in RST. RST is great for unstructured English, but displaying semi structured (and repetitive) data in tables is not it's strength. This provides tooling to insert semi-structured data describing request and response parameters, and turn those into nice tables.

The project also includes a set of styling (and javascript) that is expected to layer on top of an oslosphinx theme base. This provides a nice set of collapsing sections for REST methods and javascript controls to expand / collapse all sections.

This package contains the Python 3.x module.

Other Packages Related to python3-os-api-ref

  • depends
  • recommends
  • suggests
  • dep: python-os-api-ref-common
    Sphinx Extensions to support API reference sites in OpenStack - common
  • dep: python3
    interactive high-level object-oriented language (default python3 version)
  • dep: python3-docutils
    text processing system for reStructuredText (implemented in Python 3)
  • dep: python3-openstackdocstheme (>= 1.18.1)
    extension support for Sphin OpenStack doc - Python 3.x
  • dep: python3-pbr (>> 2.1.0)
    inject useful and sensible default behaviors into setuptools - Python 3.x
  • dep: python3-six (>= 1.10.0)
    Python 2 and 3 compatibility library (Python 3 interface)
  • dep: python3-sphinx (>= 1.6.2)
    documentation generator for Python projects (implemented in Python 3)
  • dep: python3-yaml (>= 3.12)
    YAML parser and emitter for Python3

Download python3-os-api-ref

Download for all available architectures
Architecture Package Size Installed Size Files
all 23.1 kB128 kB [list of files]