sphinxcontrib-viewsource

Add an “Edit on GitHub” button to your code examples.

sphinxcontrib-viewsource is a Sphinx extension that enhances the literalinclude directive, adding a caption automatically with a link pointing to the source file.

Use it to add an Edit on GitHub button to your code source files, or to show the complete code when the literalinclude directive renders a subset of the file.

Example

Edit on GitHub

    print('Hello World!')

Add the extension to your project following the installation instructions.

Table of Contents

• Installation
  • Getting Started
• Resolve Link
  • Point to an internal file
  • Point to an external file
  • Resolution strategy per language
• Changelog
  • [0.1.3] - 18 April 2019