Merge remote-tracking branch 'upstream/main' into swap-nox-tox

CONTRIBUTING.md

@@ -172,12 +172,12 @@ not include any way to view the images from the visualization tests.
 
 If you want to inspect the output from the visualization tests (which is common
 if you're working on visualizations) you can set the
-`RETWORKX_TEST_PRESERVE_IMAGES` environment variable to any value and this will
+`RUSTWORKX_TEST_PRESERVE_IMAGES` environment variable to any value and this will
 skip the cleanup. This will enable you to look at the output image and ensure the
 visualization is correct. For example, running:
 
 ```
-RETWORKX_TEST_PRESERVE_IMAGES=1 nox -e test
+RUSTWORKX_TEST_PRESERVE_IMAGES=1 nox -e test
 ```
 
 will run the visualization tests and preserve the generated image files after

README.md

@@ -25,7 +25,7 @@ any Python application.
 
 ## Project history
 
-Rustworkx was originally called retworkx and was was created initially to be
+Rustworkx was originally called retworkx and was created initially to be
 a replacement for [qiskit](https://qiskit.org/)'s previous (and current)
 networkx usage (hence the original name).  The project was originally started
 to build a faster directed graph to use as the underlying data structure for

docs/source/conf.py

@@ -71,7 +71,7 @@
 
 # Prepend warning for development docs:
 
-if not os.getenv('RETWORKX_DEV_DOCS', None):
+if not os.getenv('RUSTWORKX_DEV_DOCS', None):
     rst_prolog = """
 .. raw:: html
 
@@ -124,7 +124,7 @@
     for source_str in fd:
         redirects[f"stubs/{source_str}"] = f"../apiref/{source_str}"
 
-if os.getenv("RETWORKX_LEGACY_DOCS", None) is not None:
+if os.getenv("RUSTWORKX_LEGACY_DOCS", None) is not None:
     redirects["*"] = "https://qiskit.org/ecosystem/rustworkx/$source.html"
     html_baseurl = "https://qiskit.org/ecosystem/rustworkx/"
 
@@ -152,7 +152,7 @@ def _get_versions(app, config):
 
 
 def _get_version_label(current_version):
-    if not os.getenv('RETWORKX_DEV_DOCS', None):
+    if not os.getenv('RUSTWORKX_DEV_DOCS', None):
         current_version_info = current_version.split('.')
         return ".".join(current_version_info[:-1])
     else:

tests/retworkx_backwards_compat/visualization/test_graphviz.py

@@ -31,7 +31,7 @@
 except Exception:
     HAS_PILLOW = False
 
-SAVE_IMAGES = os.getenv("RETWORKX_TEST_PRESERVE_IMAGES", None)
+SAVE_IMAGES = os.getenv("RUSTWORKX_TEST_PRESERVE_IMAGES", None)
 
 
 def _save_image(image, path):

tests/retworkx_backwards_compat/visualization/test_mpl.py

@@ -29,7 +29,7 @@
 except ImportError:
     HAS_MPL = False
 
-SAVE_IMAGES = os.getenv("RETWORKX_TEST_PRESERVE_IMAGES", None)
+SAVE_IMAGES = os.getenv("RUSTWORKX_TEST_PRESERVE_IMAGES", None)
 
 
 def _save_images(fig, path):

tests/rustworkx_tests/visualization/test_graphviz.py

@@ -31,7 +31,7 @@
 except Exception:
     HAS_PILLOW = False
 
-SAVE_IMAGES = os.getenv("RETWORKX_TEST_PRESERVE_IMAGES", None)
+SAVE_IMAGES = os.getenv("RUSTWORKX_TEST_PRESERVE_IMAGES", None)
 
 
 def _save_image(image, path):

tests/rustworkx_tests/visualization/test_mpl.py

@@ -29,7 +29,7 @@
 except ImportError:
     HAS_MPL = False
 
-SAVE_IMAGES = os.getenv("RETWORKX_TEST_PRESERVE_IMAGES", None)
+SAVE_IMAGES = os.getenv("RUSTWORKX_TEST_PRESERVE_IMAGES", None)
 
 
 def _save_images(fig, path):

tools/deploy_documentation_dev.sh

@@ -21,7 +21,7 @@ sudo apt-get install -y ./rclone.deb
 RCLONE_CONFIG_PATH=$(rclone config file | tail -1)
 
 # Build the documentation.
-RETWORKX_DEV_DOCS=1 nox -e docs
+RUSTWORKX_DEV_DOCS=1 nox -e docs
 
 echo "show current dir: "
 pwd