sphinx-collections 0.3.1

Sphinx collections extension for mapping directories and services as document folders

Complete documentation: http://sphinx-collections.readthedocs.io/en/latest/

Welcome to

Sphinx-Collections is a Sphinx extension to collect and generate additional files from different sources. These files are added to the Sphinx Source Folder, so that Sphinx takes them into account for the overall documentation build.

Sphinx Collections supports multiple collections, where each collection has its own source and target folder, specific configuration and use case based driver.

A collection can be activated by default or its usage can be triggered by Sphinx tags.

Depending on the usage of a specific collection for a build, its content integration can be controlled by the if-collection:: directive .

Following use cases are supported:

• Create file with content from string

• Create file with content from function call

• Copy single file from local path

• Copy folder tree from local path

• Create a symlink to a local target

• Create a usage-report of collections

• Clone git repository

• Create multiple files based on jinja-template and specific data

Sphinx-Collections cares about keeping your collection folders clean before and after each build.

Installation

Install via pip: pip install sphinx-collections.

Then add the extension to the conf.py file of your Sphinx project:

extensions = [
    "sphinx_collections",
    # other extensions
]

Important

Breaking Change in Version 0.3.0

The package has been renamed from sphinxcontrib.collections to sphinx_collections.

The PyPI package name is still sphinx-collections, but the import/extension name has changed:

Old (before 0.3.0):

# In conf.py
extensions = [
    "sphinxcontrib.collections",  # OLD - no longer works
]

New (0.3.0 and later):

# In conf.py
extensions = [
    "sphinx_collections",  # NEW
]

Introduction

Sphinx-Collections gets completely configured by variables inside the conf.py file of your Sphinx project:

collections = {
   'my_files': {
      'driver': 'copy_folder',
      'source': '../../extra_files/'
   }
}

The driver copy_folder allows to copy local folders and their files into your Sphinx project. There are other drivers available, which support different use cases and file locations.

By default all files get copied to _collections/ + collection_name, so in this example the complete path inside your documentation folder would be _collections/my_files/. The location can be set specific for each collection by using target option.

Then you can reference the copied files by using a toctree:

.. toctree::
   _collections/my_files/index

Please see the documentation of the needed Driver to know which options are available and necessary.

Tag based collections

Use Sphinx tags to collect and integrate only needed data:

 collections = {
   'my_files': {
      'driver': 'copy',
      'source': '../../extra_files/',
      'tags': ['user_manual'],  # gets active, if "user_manual" is set as tag
      'active': False,  # by default, collection shall not be executed
   }
}

Then run sphinx-build with -t option:

sphinx-build -b html -t user_manual . _build/html

Collection based content

Use if-collection to add content to a page only, if a specified collections has been executed successfully.

.. if-collection:: my_test, my_data

   My Test & Data chapter
   ----------------------

    .. toctree::

      /_collections/my_test/index
      /_collections/my_data/index

For more information take a look into the documentation of if-collection.

Motivation

This sphinx extension is based on the needs of a software development team inside a german automotive company.

The project team was searching for a practical way to support multiple sphinx-based documentations inside a mono-repository and have the possibility to merge different documentations together or to add files based on external data.

Sphinx-Collections is part of a software bundle, which was designed to support the development of ISO 26262 compliant software. Other tools are: sphinx-needs, sphinx-test-reports, tox-envreport.