Skip to content

Commit

Permalink
The necessary change for the release of the latest version (#74)
Browse files Browse the repository at this point in the history
  • Loading branch information
fretchen authored Sep 28, 2023
1 parent f9d9bda commit 36e62d7
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 44 deletions.
78 changes: 39 additions & 39 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,25 +38,27 @@

# Set env flag so that we can doc functions that may otherwise not be loaded
# see for example interactive visualizations in qiskit.visualization.
os.environ['QISKIT_DOCS'] = 'TRUE'
os.environ["QISKIT_DOCS"] = "TRUE"

# -- Project information -----------------------------------------------------
project = 'Qiskit Cold Atom'
copyright = '2021, Qiskit Cold Atom Development Team' # pylint: disable=redefined-builtin
author = 'Qiskit Cold Atom Development Team'
project = "Qiskit Cold Atom"
copyright = "2021 - 2023, Qiskit Cold Atom Development Team" # pylint: disable=redefined-builtin
author = "Qiskit Cold Atom Development Team"

# The short X.Y version
version = "0.1"
version = "0.2"
# The full version, including alpha/beta/rc tags
release = '0.1.1'
release = "0.2.1"

rst_prolog = """
.. raw:: html
<br><br><br>
.. |version| replace:: {0}
""".format(release)
""".format(
release
)

nbsphinx_prolog = """
{% set docname = env.doc2path(env.docname, base=None) %}
Expand All @@ -76,26 +78,26 @@
# -- General configuration ---------------------------------------------------

extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx.ext.extlinks',
'sphinx_tabs.tabs',
'jupyter_sphinx',
'sphinx_autodoc_typehints',
'reno.sphinxext',
'sphinx.ext.doctest',
'nbsphinx',
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx.ext.extlinks",
"sphinx_tabs.tabs",
"jupyter_sphinx",
"sphinx_autodoc_typehints",
"reno.sphinxext",
"sphinx.ext.doctest",
"nbsphinx",
"qiskit_sphinx_theme",
]
templates_path = ['_templates']
templates_path = ["_templates"]

nbsphinx_timeout = 360
nbsphinx_execute = os.getenv('QISKIT_DOCS_BUILD_TUTORIALS', 'never')
nbsphinx_widgets_path = ''
exclude_patterns = ['_build', '**.ipynb_checkpoints']
nbsphinx_execute = os.getenv("QISKIT_DOCS_BUILD_TUTORIALS", "never")
nbsphinx_widgets_path = ""
exclude_patterns = ["_build", "**.ipynb_checkpoints"]
nbsphinx_thumbnails = {}

# -----------------------------------------------------------------------------
Expand All @@ -110,10 +112,10 @@
# -----------------------------------------------------------------------------

autodoc_default_options = {
'inherited-members': None,
"inherited-members": None,
}

autoclass_content = 'both'
autoclass_content = "both"

# If true, figures, tables and code-blocks are automatically numbered if they
# have a caption.
Expand All @@ -122,9 +124,7 @@
# A dictionary mapping 'figure', 'table', 'code-block' and 'section' to
# strings that are used for format of figure numbers. As a special character,
# %s will be replaced to figure number.
numfig_format = {
'table': 'Table %s'
}
numfig_format = {"table": "Table %s"}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
Expand All @@ -135,10 +135,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', '**.ipynb_checkpoints']
exclude_patterns = ["_build", "**.ipynb_checkpoints"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'colorful'
pygments_style = "colorful"

# A boolean that decides whether module names are prepended to all object names
# (for object types where a “module” of some kind is defined), e.g. for
Expand All @@ -160,14 +160,14 @@
html_theme = "qiskit_sphinx_theme"

html_theme_options = {
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
"logo_only": False,
"display_version": True,
"prev_next_buttons_location": "bottom",
"style_external_links": False,
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False,
"collapse_navigation": True,
"sticky_navigation": True,
"navigation_depth": 4,
"includehidden": True,
"titles_only": False,
}
2 changes: 1 addition & 1 deletion qiskit_cold_atom/VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0
0.2.1
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
description="Integration of cold atomic experiments into the Qiskit SDK.",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/Qiskit-Extensions/qiskit-cold-atom",
url="https://github.com/qiskit-community/qiskit-cold-atom",
author="Qiskit cold atom development team",
license="Apache 2.0",
classifiers=[
Expand All @@ -50,9 +50,7 @@
"Topic :: Scientific/Engineering",
],
keywords="qiskit sdk quantum cold atoms",
packages=setuptools.find_packages(
include=["qiskit_cold_atom", "qiskit_cold_atom.*"]
),
packages=setuptools.find_packages(include=["qiskit_cold_atom", "qiskit_cold_atom.*"]),
install_requires=REQUIREMENTS,
include_package_data=True,
python_requires=">=3.6",
Expand Down

0 comments on commit 36e62d7

Please sign in to comment.