sphinxcontrib-opencontracting 0.0.9#

This Python package provides Sphinx directives for OCDS documentation.

To install:

pip install sphinxcontrib-opencontracting

Then, add to the conf.py file:

extensions = ['sphinxcontrib.opencontracting']

If you are viewing this on GitHub or PyPI, open the full documentation for additional details.

field-description#

With a schema.json file like:

{
  "properties": {
    "field": {
      "description": "A description"
    }
  }
}

Use:

.. field-description:: schema.json /properties/field

To render:

A description

code-description#

With a codelist.csv file like:

Code,Title,Description
a,A,A description
b,B,B description

Use:

.. code-description:: codelist.csv a

To render:

A description

extensionexplorerlinklist#

Add to the conf.py file:

extension_versions = {
    'bids': 'v1.1.5',
    'lots': 'v1.1.5',
}

Use:

.. extensionexplorerlinklist::

To render:

extensionlist#

Add to the conf.py file:

extension_versions = {
    'bids': 'v1.1.5',
    'lots': 'v1.1.5',
}

Use:

.. extensionlist:: The following extensions are available for the tender section
   :list: tender

To render:

The following extensions are available for the tender section

Lots: A tender process can be divided into lots, where bidders can bid on one or more lots. Details of each lot can be provided here. Items, documents and other features may then reference the lot they are related to using relatedLot. Where no relatedLot identifier is given, the values ought to be interpreted as applicable to the whole tender.

workedexample and workedexamplelist#

Use:

.. workedexample:: Unsuccessful tender
   :tag: tender

.. workedexamplelist:: The following worked examples are available for the tender section
   :tag: tender

Where:

The workedexample directive is used at the top of a section to mark the content as a worked example. Its argument is used as the text of the hyperlink rendered by the workedexamplelist directive. Tag the worked example with one or more comma-separated tags, using the tags option.
The workedexamplelist directive is used to list all the worked examples tagged with the specified tag.

To render:

The following extensions are available for the tender section

Unsuccessful tender

Contents

Changelog