Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
46 lines (27 sloc) 1.32 KB

sphinxcontrib-merge

PyPI version Travis Status

Sphinx extension to build documentation from multiple remote sources.

For example, you can use it to produce a consistent documentation site by merging pages hosted in different GitHub repositories.

Installation

  1. Install sphinxcontrib-merge using pip.
pip install sphinxcontrib-merge
  1. Add the extension to your Sphinx project conf.py file.
extensions = ['sphinxcontrib.merge']

Usage

Use the merge directive to render the content of a remote file:

.. merge:: https://raw.githubusercontent.com/dgarcia360/sphinxcontrib-merge/master/docs/example.rst

Note: At the current moment the extension only works with .rst files.

Roadmap

See the open issues for a list of proposed features.

Contributing

Contributions are welcome and appreciated! Check CONTRIBUTING.md file.

License

Copyright (c) 2019 David Garcia (@dgarcia360).

Licensed under MIT license (see LICENSE.md for details)

You can’t perform that action at this time.