Skip to content
This repository has been archived by the owner on Jul 24, 2024. It is now read-only.

Commit

Permalink
[WIP] Upgrade to new Qiskit Sphinx Theme
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric-Arellano committed Jul 17, 2023
1 parent 03cdd7e commit 466c14c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 24 deletions.
27 changes: 5 additions & 22 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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'
4 changes: 2 additions & 2 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 466c14c

Please sign in to comment.