Changeset - c7200d49b027
[Not reviewed]
0 3 0
Branko Majic (branko) - 9 months ago 2025-02-21 18:45:02
branko@majic.rs
MAR-245: Add conveniece copy buttons to documentation code blocks:

- Makes usage instructions testing a bit smoother/simpler.
- Unfortunately, does not add copy buttons to file path blocks.
3 files changed with 7 insertions and 1 deletions:
0 comments (0 inline, 0 general)
docs/conf.py
Show inline comments
 
@@ -7,22 +7,24 @@
 

	
 
# -- Project information -----------------------------------------------------
 
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 

	
 
project = 'Majic Ansible Roles'
 
copyright = '2018, 2019, 2020, 2021, 2023, 2024 Branko Majic'
 
author = 'Branko Majic'
 
release = '8.0-dev'
 

	
 
# -- General configuration ---------------------------------------------------
 
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 

	
 
extensions = []
 
extensions = [
 
    'sphinx_copybutton',
 
]
 

	
 
templates_path = ['_templates']
 
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 

	
 
# -- Options for HTML output -------------------------------------------------
 
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

	
 
html_theme = 'sphinx_rtd_theme'
 
html_static_path = ['_static']
requirements.in
Show inline comments
 
@@ -24,17 +24,18 @@ gimmecert
 
#   upgraded eventually, it might be worth it to also look into
 
#   splitting out this ClamAV database cache explicitly into some
 
#   directory like ~/.cache/majic-ansible-roles-clamavdb instead of
 
#   relying on the Molecule ephemeral directory.
 
molecule[testinfra]~=25.1.0
 
molecule-plugins[vagrant]~=23.7.0
 
paramiko
 
pytest-env
 

	
 
# Documentation.
 
sphinx
 
sphinx-rtd-theme
 
sphinx-copybutton
 

	
 
# Python virtualenv management.
 
pip
 
pip-tools
 
setuptools
requirements.txt
Show inline comments
 
@@ -198,26 +198,29 @@ rpds-py==0.23.1
 
    #   referencing
 
ruamel-yaml==0.18.10
 
    # via ansible-lint
 
ruamel-yaml-clib==0.2.12
 
    # via ruamel-yaml
 
six==1.17.0
 
    # via python-dateutil
 
snowballstemmer==2.2.0
 
    # via sphinx
 
sphinx==8.2.0
 
    # via
 
    #   -r requirements.in
 
    #   sphinx-copybutton
 
    #   sphinx-rtd-theme
 
    #   sphinxcontrib-jquery
 
sphinx-copybutton==0.5.2
 
    # via -r requirements.in
 
sphinx-rtd-theme==3.0.2
 
    # via -r requirements.in
 
sphinxcontrib-applehelp==2.0.0
 
    # via sphinx
 
sphinxcontrib-devhelp==2.0.0
 
    # via sphinx
 
sphinxcontrib-htmlhelp==2.1.0
 
    # via sphinx
 
sphinxcontrib-jquery==4.1
 
    # via sphinx-rtd-theme
 
sphinxcontrib-jsmath==1.0.1
 
    # via sphinx
0 comments (0 inline, 0 general)