From 466c14c8634929195421be4cbc35a7879250fd2c Mon Sep 17 00:00:00 2001 From: Eric Arellano Date: Mon, 17 Jul 2023 13:58:14 -0600 Subject: [PATCH] [WIP] Upgrade to new Qiskit Sphinx Theme --- docs/conf.py | 27 +++++---------------------- requirements-dev.txt | 4 ++-- 2 files changed, 7 insertions(+), 24 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e5d6a287d..0e5b5551e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,6 @@ -# -*- coding: utf-8 -*- - # This code is part of Qiskit. # -# (C) Copyright IBM 2021. +# (C) Copyright IBM 2021, 2023. # # This code is licensed under the Apache License, Version 2.0. You may # obtain a copy of this license in the LICENSE.txt file in the root directory @@ -94,20 +92,18 @@ nbsphinx_prolog += link_str + "{{ docname }}" # ----------------------------------------------------------------------------- -# Autosummary +# Autosummary & autodoc # ----------------------------------------------------------------------------- autosummary_generate = True -# ----------------------------------------------------------------------------- -# Autodoc -# ----------------------------------------------------------------------------- - autodoc_default_options = { 'inherited-members': None, 'exclude-members': 'with_traceback' } +autoclass_content = 'both' + # If true, figures, tables and code-blocks are automatically numbered if they # have a caption. @@ -145,24 +141,11 @@ # 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 - - # -- Options for HTML output ------------------------------------------------- -html_theme = 'qiskit_sphinx_theme' +html_theme = 'qiskit' html_logo = 'images/logo.png' html_last_updated_fmt = '%Y/%m/%d' -html_theme_options = { - 'logo_only': True, - 'display_version': True, - 'prev_next_buttons_location': 'bottom', - 'style_external_links': True, -} - html_sourcelink_suffix = '' - -autoclass_content = 'both' diff --git a/requirements-dev.txt b/requirements-dev.txt index 760631795..0240d654e 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -25,9 +25,9 @@ qiskit-ibmq-provider>=0.19.2 # Documentation jupyter-sphinx nbsphinx>=0.9.2 -Sphinx>=5.3.0 +Sphinx>=6.0.0 sphinx-tabs>=1.1.11 sphinx-automodapi sphinx-autodoc-typehints<=1.19.2 reno>=2.11.0 -qiskit-sphinx-theme~=1.11.1 +qiskit-sphinx-theme~=1.13.1