Skip to content

Commit

Permalink
rename package in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
NicoRenaud committed May 21, 2024
1 parent fc6a700 commit 4ca5a5c
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 11 deletions.
4 changes: 2 additions & 2 deletions docs/apidocs/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. prototype_template:
.. qiskit_tomography_toolbox:
.. module:: prototype_template
.. module:: qiskit_tomography_toolbox

=============================
Template API References
Expand Down
2 changes: 1 addition & 1 deletion docs/apidocs/template.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. automodule:: prototype_template.template_module
.. automodule:: qiskit_tomography_toolbox.template_module
:no-members:
:no-inherited-members:
:no-special-members:
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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])

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Template project documentation
Home <self>


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
Expand Down
10 changes: 6 additions & 4 deletions ecosystem.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
}
}
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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']

0 comments on commit 4ca5a5c

Please sign in to comment.