Add comments and annotation to your documentation.

Project description

sphinx-comments

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

You can install sphinx-comments with pip:

pip install sphinx-comments

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!

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)

0.0.3

Aug 12, 2020

0.0.2

Aug 11, 2020

This version

0.0.1

Aug 11, 2020

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Uploaded Aug 11, 2020 Source

Uploaded Aug 11, 2020 Python 3

Details for the file sphinx-comments-0.0.1.tar.gz.

Download URL: sphinx-comments-0.0.1.tar.gz
Upload date: Aug 11, 2020
Size: 8.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0

Details for the file sphinx_comments-0.0.1-py3-none-any.whl.

Download URL: sphinx_comments-0.0.1-py3-none-any.whl
Upload date: Aug 11, 2020
Size: 4.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/42.0.1.post20191125 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.8.0