Add copybutton extension to template docs. (#429)

* Add copybutton extension to template docs.

* Formatting.

Author: delucchi-cmu

python-project-template/{% if include_docs %}docs{% endif %}/conf.py.jinja

@@ -31,6 +31,16 @@ extensions.append("autoapi.extension")
 extensions.append("nbsphinx")
 {%- endif %}
 
+# -- sphinx-copybutton configuration ----------------------------------------
+extensions.append("sphinx_copybutton")
+## sets up the expected prompt text from console blocks, and excludes it from
+## the text that goes into the clipboard.
+copybutton_exclude = ".linenos, .gp"
+copybutton_prompt_text = ">> "
+
+## lets us suppress the copy button on select code blocks.
+copybutton_selector = "div:not(.no-copybutton) > div.highlight > pre"
+
 templates_path = []
 exclude_patterns = ["_build", "**.ipynb_checkpoints"]
 

python-project-template/{% if include_docs %}docs{% endif %}/index.rst.jinja

@@ -13,7 +13,7 @@ virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage
 environments. If you have conda installed locally, you can run the following to
 create and activate a new environment.
 
-.. code-block:: bash
+.. code-block:: console
 
    >> conda create env -n <env_name> python=3.10
    >> conda activate <env_name>
@@ -22,7 +22,7 @@ create and activate a new environment.
 Once you have created a new environment, you can install this project for local
 development using the following commands:
 
-.. code-block:: bash
+.. code-block:: console
 
    >> pip install -e .'[dev]'
    >> pre-commit install

python-project-template/{% if include_docs %}docs{% endif %}/requirements.txt.jinja

@@ -1,6 +1,7 @@
 sphinx
 sphinx-rtd-theme
 sphinx-autoapi
+sphinx-copybutton
 {%- if include_notebooks %}
 nbsphinx
 ipython