sphinx-comments 0.0.1

Add comments and annotation to your documentation.

sphinx-comments

|

A small sphinx extension to add a "copy" button to code blocks.

See the sphinx-comments documentation for more details!

Installation

You can install sphinx-comments with pip:

pip install sphinx-comments

Usage

In your conf.py configuration file, add sphinx_comments to your extensions list. E.g.:

extensions = [
    ...
    'sphinx_comments'
    ...
]

When you build your site, your code blocks should now have little copy buttons to their right. Clicking the button will copy the code inside!

Customization

If you'd like to customize the look of the copy buttons, you can over-write any of the CSS rules specified in the sphinx-comments CSS file (link)