Remove non-API docs (#773)

* Remove non-API docs * Fix makefile
Qiskit · Dec 4, 2023 · 0569026 · 0569026
1 parent 6be5f32
commit 0569026
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 2,895 deletions.
diff --git a/Makefile b/Makefile
@@ -21,7 +21,7 @@ mypy:
 	mypy --module qiskit_ibm_provider --package test
 
 style:
-	black --check qiskit_ibm_provider test setup.py docs/tutorials
+	black --check qiskit_ibm_provider test setup.py
 
 unit-test:
 	python -m unittest discover --verbose --top-level-directory . --start-directory test/unit
@@ -47,4 +47,4 @@ e2e-test:
 	python -m unittest discover --verbose --top-level-directory . --start-directory test/e2e
 
 black:
-	black qiskit_ibm_provider test setup.py docs/tutorials
+	black qiskit_ibm_provider test setup.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,35 +10,10 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-# pylint: disable=invalid-name
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# 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('.'))
-
-"""
-Sphinx documentation builder
-"""
-
-import os
-# 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'
 
 # -- Project information -----------------------------------------------------
 project = 'Qiskit IBM Quantum Provider'
-copyright = '2022, Qiskit Development Team'  # pylint: disable=redefined-builtin
+project_copyright = '2023, Qiskit Development Team'
 author = 'Qiskit Development Team'
 
 # The short X.Y version
@@ -59,37 +34,13 @@
     'jupyter_sphinx',
     'sphinx_autodoc_typehints',
     'reno.sphinxext',
-    'nbsphinx',
-    "qiskit_sphinx_theme",
 ]
 templates_path = ['_templates']
 
 intersphinx_mapping = {
     "qiskit": ("https://qiskit.org/documentation/", None),
 }
 
-nbsphinx_timeout = 300
-nbsphinx_execute = "never"
-nbsphinx_widgets_path = ''
-
-nbsphinx_thumbnails = {"**": "_static/images/logo.png"}
-
-nbsphinx_prolog = """
-{% set docname = env.doc2path(env.docname, base=None) %}
-.. only:: html
-
-    .. role:: raw-html(raw)
-        :format: html
-
-    .. note::
-        This page was generated from `docs/{{ docname }}`__.
-
-        __"""
-
-vers = release.split(".")
-link_str = f" https://github.com/Qiskit/qiskit-ibm-provider/blob/stable/{vers[0]}.{vers[1]}/docs/"
-nbsphinx_prolog += link_str + "{{ docname }}"
-
 # -----------------------------------------------------------------------------
 # Autosummary & autodoc
 # -----------------------------------------------------------------------------
@@ -142,18 +93,9 @@
 
 # -- Options for HTML output -------------------------------------------------
 
-html_theme = "qiskit-ecosystem"
+html_theme = "alabaster"
 html_title = f"{project} {release}"
 
-html_logo = "images/ibm-quantum-logo.png"
-
-html_theme_options = {
-    # Because this is an IBM-focused project, we use a blue color scheme.
-    "light_css_variables": {
-        "color-brand-primary": "var(--qiskit-color-blue)",
-    },
-}
-
 html_last_updated_fmt = '%Y/%m/%d'
 
 html_sourcelink_suffix = ''
diff --git a/docs/images/ibm-quantum-logo.png b/docs/images/ibm-quantum-logo.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,15 +1,16 @@
-#########################################
-Qiskit IBM Quantum Provider documentation
-#########################################
+############################################
+Qiskit IBM Quantum Provider API docs preview
+############################################
+
+Qiskit Provider docs live at docs.quantum.ibm.com and come from https://github.com/Qiskit/documentation.
+This site is only used to generate our API docs, which then get migrated to
+https://github.com/Qiskit/documentation.
 
 .. toctree::
   :maxdepth: 1
 
-  Tutorials <tutorials>
-  Migration Guide <tutorials/Migration_Guide_from_qiskit-ibmq-provider>
   API References <apidocs/ibm-provider>
   Release Notes <release_notes>
-  GitHub <https://github.com/Qiskit/qiskit-ibm-provider>
 
 .. Hiding - Indices and tables
    :ref:`genindex`

diff --git a/docs/tutorials.rst b/docs/tutorials.rst
diff --git a/docs/tutorials/1_the_ibm_quantum_account.ipynb b/docs/tutorials/1_the_ibm_quantum_account.ipynb
diff --git a/docs/tutorials/2_jupyter_tools.ipynb b/docs/tutorials/2_jupyter_tools.ipynb