Update to PPT v1.5.3

lincc-frameworks · Feb 16, 2024 · 0bacd89 · 0bacd89
1 parent 5e29e36
commit 0bacd89
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 6 deletions.
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: v1.5.1-11-g34358f1
+_commit: v1.5.3
 _src_path: gh:lincc-frameworks/python-project-template
 author_email: [email protected]
 author_name: Sandro Campos

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -42,7 +42,6 @@ repos:
         name: Validate pyproject.toml
         description: Verify that pyproject.toml adheres to the established schema.
 
-
     # Automatically sort the imports used in .py files
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0
@@ -52,8 +51,6 @@ repos:
         description: Sort and organize imports in .py and .pyi files.
         types_or: [python, pyi]
 
-
-
     # Analyze the src code style and report code that doesn't adhere.
   - repo: local
     hooks:

diff --git a/docs/conf.py b/docs/conf.py
@@ -29,6 +29,16 @@
 extensions.append("autoapi.extension")
 extensions.append("nbsphinx")
 
+# -- 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"]
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -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

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,7 @@
 sphinx
 sphinx-rtd-theme
 sphinx-autoapi
+sphinx-copybutton
 nbsphinx
 ipython
 jupytext