diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2623e598f..472d71caa 100644 --- a/CONTRIBUTING.md +++ b/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 diff --git a/Cargo.lock b/Cargo.lock index e5352e03b..1478e92f6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -680,9 +680,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.105" +version = "1.0.106" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "693151e1ac27563d6dbcec9dee9fbd5da8539b20fa14ad3752b2e6d363ace360" +checksum = "2cc66a619ed80bf7a0f6b17dd063a84b88f6dea1813737cf469aef1d081142c2" dependencies = [ "itoa", "ryu", diff --git a/README.md b/README.md index 241b4315b..417e4ff29 100644 --- a/README.md +++ b/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 diff --git a/docs/source/conf.py b/docs/source/conf.py index 0addab6ef..038c463b3 100644 --- a/docs/source/conf.py +++ b/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: diff --git a/tests/retworkx_backwards_compat/visualization/test_graphviz.py b/tests/retworkx_backwards_compat/visualization/test_graphviz.py index 8a9ee6493..5d9039537 100644 --- a/tests/retworkx_backwards_compat/visualization/test_graphviz.py +++ b/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): diff --git a/tests/retworkx_backwards_compat/visualization/test_mpl.py b/tests/retworkx_backwards_compat/visualization/test_mpl.py index eb5f4b5e9..4d600c19b 100644 --- a/tests/retworkx_backwards_compat/visualization/test_mpl.py +++ b/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): diff --git a/tests/rustworkx_tests/visualization/test_graphviz.py b/tests/rustworkx_tests/visualization/test_graphviz.py index af2733141..f0be1d562 100644 --- a/tests/rustworkx_tests/visualization/test_graphviz.py +++ b/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): diff --git a/tests/rustworkx_tests/visualization/test_mpl.py b/tests/rustworkx_tests/visualization/test_mpl.py index 001f0e658..312c857f6 100644 --- a/tests/rustworkx_tests/visualization/test_mpl.py +++ b/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): diff --git a/tools/deploy_documentation_dev.sh b/tools/deploy_documentation_dev.sh index 60483ba35..408c78e9a 100755 --- a/tools/deploy_documentation_dev.sh +++ b/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