{"author":"team useblocks","author_email":"info@useblocks.com","bugtrack_url":null,"classifiers":["Development Status :: 4 - Beta","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.5","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Topic :: Documentation","Topic :: Utilities"],"description":"**Complete documentation**: http://sphinx-collections.readthedocs.io/en/latest/\n\n.. From here shared with index.rst of docs folder. #SHARED_CONTENT\n\nWelcome to\n==========\n\n.. image:: https://github.com/useblocks/sphinx-collections/raw/master/docs/_static/sphinx_collections_logo.png\n :align: center\n\n``Sphinx-Collections`` is a Sphinx extension to collect and generate additional files from different sources.\nThese files are added to the Sphinx Source Folder, so that Sphinx takes them into account for the overall\ndocumentation build.\n\n``Sphinx Collections`` supports multiple collections, where each collection has its own\nsource and target folder, specific configuration and\n`use case based driver `_.\n\n.. image:: https://github.com/useblocks/sphinx-collections/raw/master/docs/_static/sphinx_collections_chart.png\n :align: center\n\nA collection can be activated by default or its usage can be triggered by Sphinx tags.\n\nDepending on the usage of a specific collection for a build, its content integration can be controlled by the\n`if-collection:: directive `_ .\n\n\n\nFollowing use cases are supported:\n\n* `Create file with content from string `_\n* `Create file with content from function call `_\n* `Copy single file from local path `_\n* `Copy folder tree from local path `_\n* `Create a symlink to a local target `_\n* `Create a usage-report of collections `_\n* `Clone git repository `_\n* `Create multiple files based on jinja-template and specific data `_\n\n``Sphinx-Collections`` cares about keeping your collection folders clean before and after each build.\n\nInstallation\n------------\nInstall via pip: ``pip install sphinx-collection``.\n\nThen add the extension to the ``conf.py`` file of the Sphinx project::\n\n extensions = [\n \"sphinxcontrib.collections\",\n # other extensions\n ]\n\n\nIntroduction\n------------\n\n``Sphinx-Collections`` gets completely configured by variables inside the ``conf.py`` file of your Sphinx project::\n\n collections = {\n 'my_files': {\n 'driver': 'copy_folder',\n 'source': '../../extra_files/'\n }\n }\n\nThe driver ``copy_folder`` allows to copy local folders and their files into your Sphinx project.\nThere are other drivers available, which support different use cases and file locations.\n\nBy default all files get copied to ``_collections/`` + ``collection_name``, so in this example the complete path\ninside your documentation folder would be ``_collections/my_files/``. The location can be set specific for each\ncollection by using ``target`` option.\n\nThen you can reference the copied files by using a toctree::\n\n .. toctree::\n _collections/my_files/index\n\nPlease see the\n`documentation of the needed Driver `_\nto know which options are available and necessary.\n\nTag based collections\n---------------------\n\nUse Sphinx tags to collect and integrate only needed data::\n\n collections = {\n 'my_files': {\n 'driver': 'copy',\n 'source': '../../extra_files/',\n 'tags': ['user_manual'], # gets active, if \"user_manual\" is set as tag\n 'active': False, # by default, collection shall not be executed\n }\n }\n\nThen run ``sphinx-build`` with ``-t`` option::\n\n sphinx-build -b html -t user_manual . _build/html\n\nCollection based content\n------------------------\n\nUse ``if-collection`` to add content to a page only, if a specified collections has been executed successfully.\n\n.. code-block:: rst\n\n .. if-collection:: my_test, my_data\n\n My Test & Data chapter\n ----------------------\n\n .. toctree::\n\n /_collections/my_test/index\n /_collections/my_data/index\n\nFor more information take a look into the\n`documentation of if-collection `_.\n\nMotivation\n----------\n\nThis sphinx extension is based on the needs of a software development team inside\na german automotive company.\n\nThe project team was searching for a practical way to support multiple sphinx-based documentations inside a\nmono-repository and have the possibility to merge different documentations together or to add files based\non external data.\n\nSphinx-Collections is part of a software bundle, which was designed to support the development of\n`ISO 26262 `_ compliant software.\nOther tools are:\n`sphinx-needs `_,\n`sphinx-test-reports `_,\n`tox-envreport `_.\n","description_content_type":"","docs_url":null,"download_url":"http://pypi.python.org/pypi/sphinx-collections","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"http://github.com/useblocks/sphinx-collections","keywords":"","license":"MIT","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"sphinx-collections","package_url":"https://pypi.org/project/sphinx-collections/","platform":"any","project_url":"https://pypi.org/project/sphinx-collections/","project_urls":{"Download":"http://pypi.python.org/pypi/sphinx-collections","Homepage":"http://github.com/useblocks/sphinx-collections"},"provides_extra":null,"release_url":"https://pypi.org/project/sphinx-collections/0.2.0/","requires_dist":null,"requires_python":"","summary":"Sphinx extension for collecting external data for Sphinx build.","version":"0.2.0","yanked":false,"yanked_reason":null}

Package search

sphinx-collections

project_urls

Dependencies

All package metadata

Releases