Skip to content
Build Sphinx docs from multiple remote sources ↘
Python
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
sphinxcontrib
.gitignore
.travis.yml
CHANGELOG.rst
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE.md
MANIFEST.in
README.md
setup.py
tox.ini

README.md

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.