From 4ca5a5cdc79f8787204c1c2fb4fbf5ec900fac9a Mon Sep 17 00:00:00 2001 From: Nicolas Renaud Date: Tue, 21 May 2024 17:41:27 +0200 Subject: [PATCH] rename package in doc --- docs/apidocs/index.rst | 4 ++-- docs/apidocs/template.rst | 2 +- docs/conf.py | 2 +- docs/index.rst | 2 +- ecosystem.json | 10 ++++++---- pyproject.toml | 4 ++-- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst index c8b6726..534cbc2 100644 --- a/docs/apidocs/index.rst +++ b/docs/apidocs/index.rst @@ -1,6 +1,6 @@ -.. prototype_template: +.. qiskit_tomography_toolbox: -.. module:: prototype_template +.. module:: qiskit_tomography_toolbox ============================= Template API References diff --git a/docs/apidocs/template.rst b/docs/apidocs/template.rst index a4c9d15..acd2b71 100644 --- a/docs/apidocs/template.rst +++ b/docs/apidocs/template.rst @@ -1,4 +1,4 @@ -.. automodule:: prototype_template.template_module +.. automodule:: qiskit_tomography_toolbox.template_module :no-members: :no-inherited-members: :no-special-members: diff --git a/docs/conf.py b/docs/conf.py index 470b973..b86d419 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ _rootdir = Path(__file__).parent.parent # The full version, including alpha/beta/rc tags -release = metadata_version("prototype_template") +release = metadata_version("qiskit_tomography_toolbox") # The short X.Y version version = ".".join(release.split(".")[:2]) diff --git a/docs/index.rst b/docs/index.rst index dbbb3c0..95e9b5b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ Template project documentation Home -This template repository makes creating new quantum prototype projects much easier for our team. It reduces the overhead of implementing the "bones" of a project -- including package setup, testing, and CI/CD. The code examples in this template repository are written in accordance with pylint style checks, and the sample prototype_template module has an associated unit test module. We have also included examples of coverage testing, notebook tests, and notebook lint checks and wrapped all of these using tox automated testing software. +This template repository makes creating new quantum prototype projects much easier for our team. It reduces the overhead of implementing the "bones" of a project -- including package setup, testing, and CI/CD. The code examples in this template repository are written in accordance with pylint style checks, and the sample qiskit_tomography_toolbox module has an associated unit test module. We have also included examples of coverage testing, notebook tests, and notebook lint checks and wrapped all of these using tox automated testing software. .. toctree:: :maxdepth: 1 diff --git a/ecosystem.json b/ecosystem.json index f9dc974..a7b731b 100644 --- a/ecosystem.json +++ b/ecosystem.json @@ -2,16 +2,18 @@ "dependencies_files": [], "language": { "name": "python", - "versions": ["3.9"] + "versions": [ + "3.9" + ] }, "tests_command": [ "python -m pytest -v --doctest-modules" ], "styles_check_command": [ - "pylint -rn prototype_template tests" + "pylint -rn qiskit_tomography_toolbox tests" ], "coverages_check_command": [ - "coverage3 run --source prototype_template --parallel-mode -m pytest --doctest-modules", + "coverage3 run --source qiskit_tomography_toolbox --parallel-mode -m pytest --doctest-modules", "coverage3 combine" ] -} +} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index e9f43e2..b23b6ee 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,5 +51,5 @@ build-backend = "setuptools.build_meta" py-modules = [] [tool.setuptools.packages.find] -include = ['prototype_template*'] -exclude = ['prototype_template*tests'] +include = ['qiskit_tomography_toolbox*'] +exclude = ['qiskit_tomography_toolbox*tests']