Move all of our Sphinx directives into this repository,

[Bjwebb]

and then include this as a sphinx extension everywhere that we use them.

[Bjwebb]

Places we have copies of our Sphinx directives:

• https://github.com/open-contracting/standard/blob/1.1-dev/standard/docs/en/conf.py
  • extensions = ['sphinxcontrib.jsonschema', 'ocds_sphinx_directives']
  • JSONInclude - including javascript to change how jsoninclude is displayed
  • AutoStructifyLowPriority
• https://github.com/open-contracting/public-private-partnerships/blob/master/docs/conf.py
  • extensions = ['sphinxcontrib.jsonschema', 'ocds_sphinx_directives']
  • JSONInclude
  • JSONIncludeFlat
• https://github.com/open-contracting/ocds_sphinx_directives/blob/master/ocds_sphinx_directives.py
  • ExtensionList
  • ExtensionTable
  • ExtensionSelectorTable
  • CSVTableNoTranslate
• https://github.com/ThreeSixtyGiving/standard/blob/master/documentation/conf.py
  • JSONSchemaDirective (extended)
  • JSONSchemaFieldsDirective (extended)
  • DirectoryListDirective
• https://github.com/openownership/data-standard/blob/master/docs/conf.py
  • JSONInclude
• https://github.com/openreferral/specification/blob/include-api-docs/docs/conf.py
  • extensions = ['sphinxcontrib.openapi']
  • JSONTableSchemaInclude
  • JSONSchemaDirective (extended)
• https://github.com/SocialInvestmentDataLab/spec/blob/master/docs/conf.py
  • extensions = ['sphinxcontrib.jsonschema']
  • JSONInclude

[Bjwebb]

I propose we move to this repository:

• AutoStructifyLowPriority
• JSONInclude
• JSONIncludeFlat
• CSVTableNoTranslate
• DirectoryListDirective
• JSONSchemaDirective (different for 360Giving and OpenReferral) and JSONSchemaFieldsDirective, which are all modified copies of sphinxcontrib.jsonschema.JSONSchemaDirective

Leave in ocds_sphinx_directives, because they're very specific to the way OCDS does extensions, but we should add a link to the repository in our docs:

• ExtensionList
• ExtensionTable
• ExtensionSelectorTable

Leave in openreferral specification conf.py, because its specific to JSON Schema table, which we're not likely to use elsewhere (and may move away from in the openreferral docs). We should add a mention to the docs though.

• JSONTableSchemaInclude

[Bjwebb]

Handling duplicates:

Appear only once, so we can use that copy

• AutoStructifyLowPriority
• JSONIncludeFlat
• CSVTableNoTranslate
• DirectoryListDirective

JSONInclude

Differences:

• OCDS and Social Investment are the same.
• openownership is very similar to an old copy of the OCDS directive. With just formatting and a 'TEST' string removed.
• ppps is like the old OCDS, but with formatting changes, 'TEST' removed, and two new options added.
• OCDS is like old OCDS but with an extra container node added https://github.com/open-contracting/standard/commit/520afec26ad3afc7164283df8bfe1af78c6e695d

I think the best way to combine these is to start with the ppps version, change the formatting of that so it passes flake8 tests*, and then add the extra container node as in https://github.com/open-contracting/standard/commit/520afec26ad3afc7164283df8bfe1af78c6e695d.

* and also add flake8 as a Travis test.

JSONSchemaDirective and JSONSchemaFieldsDirective

These are very deliberate extensions of sphinxcontrib.jsonschema.JSONSchemaDirective, which initially I won't merge, but instead rename to more clearly differentiate them. These could possibly stay in their separate repositories, but I think by bringing them together it gives a better overview of what's possible next time someone needs to do something similar.

[Bjwebb]

Still to move:

• [x] JSONSchemaDirective and JSONSchemaFieldsDirective
• [x] Pull requests to remove code from original repos

[Bjwebb]

I've now made PRs to remove the code from the original repos:

• https://github.com/open-contracting/standard/pull/632
• https://github.com/open-contracting/public-private-partnerships/pull/116
• https://github.com/ThreeSixtyGiving/standard/pull/224
• https://github.com/openownership/data-standard/pull/46
• https://github.com/openreferral/specification/commit/11c50ac5be4b10fc62af8827848798169383c3d9
• https://github.com/SocialInvestmentDataLab/spec/pull/16