Skip to content
This repository has been archived by the owner on Aug 19, 2023. It is now read-only.

Commit

Permalink
Bump Meta (#1328)
Browse files Browse the repository at this point in the history
* Bump version for qiskit-aqua==0.9.5

Bump the meta repo version to include:

qiskit-aqua==0.9.5

* Bump optional dep min versions

It was requested that while we're preparing a new metapackage releases
that we bump the min versions of the application module optional
dependencies to the latest releases to ensure people get the newest
versions when upgrading. This commit bumps the lower bounds.

* Bump version for qiskit-terra==0.18.2

Bump the meta repo version to include:

qiskit-terra==0.18.2

* Add release notes

* Tweak docs config from Qiskit/qiskit#6855

* Exclude template from doc lint

Co-authored-by: Matthew Treinish <[email protected]>
  • Loading branch information
qiskit-bot and mtreinish authored Sep 10, 2021
1 parent 98031df commit 32e3b75
Show file tree
Hide file tree
Showing 8 changed files with 171 additions and 78 deletions.
8 changes: 8 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Abraham Asfaw
Anish Athalye
Artur Avkhadiev
Carlos Azaustre
PRATHAMESH BHOLE
Abhik Banerjee
Santanu Banerjee
Will Bang
Expand Down Expand Up @@ -94,6 +95,7 @@ Grant Eberle
Amir Ebrahimi
Pieter Eendebak
Daniel Egger
Emilio
Alberto Espiricueta
Mark Everitt
Davide Facoetti
Expand Down Expand Up @@ -128,6 +130,7 @@ Donny Greenberg
Dmitry Grinko
Wen Guan
John A. Gunnels
Harshit Gupta
Naman Gupta
Jakob M. Günther
Mikael Haglund
Expand Down Expand Up @@ -155,6 +158,7 @@ Toshinari Itoko
Ali Javadi
Ali Javadi-Abhari
Wahaj Javed
Qian Jianhua
Madhav Jivrajani
Kiran Johns
Scott Johnstun
Expand Down Expand Up @@ -184,6 +188,7 @@ Gawel Kus
Ryan LaRose
Enrique Lacal
Raphaël Lambert
Haggai Landa
John Lapeyre
Joe Latone
Scott Lawrence
Expand Down Expand Up @@ -276,6 +281,7 @@ Sumit Puri
Daniel Puzzuoli
Jesús Pérez
Quintiii
Isha R
Rafey Iqbal Rahman
Arun Raja
Roshan Rajeev
Expand All @@ -297,6 +303,7 @@ Mingi Ryu
Tharrmashastha SAPV
Arijit Saha
Abdullah Ash- Saki
Sankalp Sanand
Martin Sandberg
Hirmay Sandesara
Ritvik Sapra
Expand Down Expand Up @@ -440,6 +447,7 @@ sternparky
strickroman
tigerjack
tsura-crisaldo
vadebayo49
welien
willhbang
yang.luh
Expand Down
2 changes: 1 addition & 1 deletion Qiskit.bib

Large diffs are not rendered by default.

41 changes: 41 additions & 0 deletions docs/_templates/autosummary/class.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{#
The general principle of this is that we manually document attributes here in
the same file, but give all methods their own page. By default, we document
all methods, including those defined by parent classes.
-#}

{{ objname | escape | underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
{#-
Avoid having autodoc populate the class with the members we're about to
summarize to avoid duplication.
#}
:no-members:
:show-inheritance:
{#
Methods all get their own separate page, with their names and the first lines
of their docstrings tabulated. The documentation from `__init__` is
automatically included in the standard class documentation, so we don't want
to repeat it.
-#}
{% block methods_summary %}{% set wanted_methods = (methods | reject('==', '__init__') | list) %}{% if wanted_methods %}
.. rubric:: Methods

.. autosummary::
:nosignatures:
:toctree: ../stubs/
{% for item in wanted_methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}{% endblock %}

{% block attributes_summary %}{% if attributes %}
.. rubric:: Attributes
{# Attributes should all be summarized directly on the same page. -#}
{% for item in attributes %}
.. autoattribute:: {{ item }}
{%- endfor %}
{% endif %}{% endblock -%}
38 changes: 38 additions & 0 deletions docs/_templates/autosummary/class_no_inherited_members.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{#
This is very similar to the default class template, except this one is used
when we don't want to generate any inherited methods.
-#}

{{ objname | escape | underline }}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}
{#-
Avoid having autodoc populate the class with the members we're about to
summarize to avoid duplication.
#}
:no-members:
:show-inheritance:
{#
Methods all get their own separate page, with their names and the first lines
of their docstrings tabulated.
-#}
{% block methods_summary %}{% set wanted_methods = (methods | reject('in', inherited_members) | reject('==', '__init__') | list) %}{% if wanted_methods %}
.. rubric:: Methods Defined Here

.. autosummary::
:nosignatures:
:toctree: ../stubs/
{% for item in wanted_methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}{% endblock %}

{% block attributes_summary %}{% if attributes %}
.. rubric:: Attributes
{# Attributes should all be summarized directly on the same page. -#}
{% for item in attributes %}
.. autoattribute:: {{ item }}
{%- endfor %}
{% endif %}{% endblock -%}
88 changes: 19 additions & 69 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
Expand All @@ -33,43 +27,36 @@
CustomGalleryItemDirective, CustomCalloutItemDirective,
CustomCardItemDirective)

# -- Project information -----------------------------------------------------
from distutils import dir_util
import re
import shutil
import subprocess
import tempfile
import warnings

# -- General configuration ---------------------------------------------------

project = 'Qiskit'
copyright = '2021, Qiskit Development Team'
author = 'Qiskit Development Team'

# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = '0.29.0'
release = '0.29.1'

rst_prolog = """
.. |version| replace:: {0}
""".format(release)

# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.napoleon',
'sphinx.ext.autodoc',
"sphinx.ext.autosummary",
'sphinx.ext.mathjax',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinx.ext.viewcode',
'sphinx.ext.extlinks',
'sphinx_automodapi.automodapi',
'sphinx_autodoc_typehints',
'jupyter_sphinx',
'nbsphinx',
'sphinx_panels',
Expand Down Expand Up @@ -121,9 +108,6 @@
'index.html'
]

# -----------------------------------------------------------------------------
# Redirects
# -----------------------------------------------------------------------------
redirects = {
"install": "getting_started.html",
}
Expand Down Expand Up @@ -179,32 +163,17 @@
"tabs-color-label-active": "rgb(138, 63, 252)",
"tabs-color-label-inactive": "rgb(221, 225, 230)",
}
templates_path = ['_templates']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['theme/']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# If true, figures, tables and code-blocks are automatically numbered if they
# have a caption.
# Number figures, tables and code-blocks if they have a caption.
numfig = True

# 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'
}
# Available keys are 'figure', 'table', 'code-block' and 'section'. '%s' is the number.
numfig_format = {'table': 'Table %s'}
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
Expand All @@ -213,12 +182,9 @@
locale_dirs = ['locale/'] # path is example but recommended.
gettext_compact = False # optional.

# The name of the Pygments (syntax highlighting) style to use.
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
# py:function directives.
# Whether module names are included in crossrefs of functions, classes, etc.
add_module_names = False

# A list of prefixes that are ignored for sorting the Python module index
Expand All @@ -227,9 +193,10 @@
# package. Works only for the HTML builder currently.
modindex_common_prefix = ['qiskit.']



# -- Configuration for extlinks extension ------------------------------------
# Refer to https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html

extlinks = {
'pull_terra': ('https://github.com/Qiskit/qiskit-terra/pull/%s', '#'),
'pull_aqua': ('https://github.com/Qiskit/qiskit-aqua/pull/%s', '#'),
Expand All @@ -240,17 +207,7 @@

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "qiskit_sphinx_theme"

html_theme_path = ['.', qiskit_sphinx_theme.get_html_theme_path()]

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'logo_only': False,
'display_version': True,
Expand All @@ -263,27 +220,20 @@
'includehidden': True,
'titles_only': False,
}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
templates_path = ['_templates']
html_css_files = ['custom.css', 'gallery.css']

html_favicon = 'images/favicon.ico'

html_last_updated_fmt = '%Y/%m/%d'

# -- Options for Autosummary and Autodoc ------------------------------------
# Note that setting autodoc defaults here may not have as much of an effect as you may expect; any
# documentation created by autosummary uses a template file (in autosummary in the templates path),
# which likely overrides the autodoc defaults.
autosummary_generate = True
autosummary_generate_overwrite = False

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

autoclass_content = 'both'
# -- Extension configuration -------------------------------------------------

# --- Custom Extensions -----------------------------------------------------

# Elements with api doc sources
qiskit_elements = ['qiskit-terra', 'qiskit-aer', 'qiskit-ignis',
Expand Down
56 changes: 56 additions & 0 deletions docs/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,62 @@ This table tracks the meta-package versions and the version of each Qiskit eleme
Notable Changes
###############

*************
Qiskit 0.29.1
*************

.. _Release Notes_0.18.2:

Terra 0.18.2
============

.. _Release Notes_0.18.2_Bug Fixes:

Bug Fixes
---------

- Fixed an issue with the :func:`~qiskit.compiler.assemble` function when
called with the ``backend`` kwarg set and the ``parametric_pulses`` kwarg
was set to an empty list the output qobj would contain the
``parametric_pulses`` setting from the given backend's
:class:`~qiskit.providers.models.BackendConfiguration` instead of the
expected empty list.
Fixed `#6898 <https://github.com/Qiskit/qiskit-terra/issues/6898>`__

- The Matplotlib circuit drawer will no longer duplicate drawings when using
``ipykernel>=6.0.0``.
Fixes `#6889 <https://github.com/Qiskit/qiskit-terra/issues/6889>`__.

Aer 0.8.2
=========

No change

Ignis 0.6.0
===========

No change

.. _Release Notes_Aqua_0.9.5:

Aqua 0.9.5
==========

.. _Release Notes_Aqua_0.9.5_Bug Fixes:

Bug Fixes
---------

- Fixed a handling error in the Yahoo provider when only one ticker is entered.
Added exception error if no ticker is entered.
Limit yfinance to >=0.1.62 as previous versions have a JSON decoder error.

IBM Q Provider 0.16.0
=====================

No change


*************
Qiskit 0.29.0
*************
Expand Down
Loading

0 comments on commit 32e3b75

Please sign in to comment.