From 36113f49a4726312a508b4a5f84ebfa571e1b785 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 13:48:24 -0500 Subject: [PATCH 01/18] Remove navbar_active_link option from theme --- doc/conf.py | 1 - doc/requirements.txt | 2 +- requirements.txt | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 354bdad..0ae5c19 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -136,7 +136,6 @@ "of Google Inc." ], "toc_overview": True, - "navbar_active_link": 3, "google_analytics_tracking_id": "G-C480Z9JL0D" } diff --git a/doc/requirements.txt b/doc/requirements.txt index e8cbdfb..3c74386 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -28,7 +28,7 @@ retworkx==0.11.0 scipy==1.10.0 semantic-version==2.7 snowballstemmer==2.2.0 -Sphinx==4.5.0 +sphinx==4.5.0 sphinx-automodapi==0.14.1 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 diff --git a/requirements.txt b/requirements.txt index fd4fc49..08d3b06 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,6 +15,6 @@ PyJWT==2.4.0 requests==2.31.0 retworkx==0.11.0 scipy==1.10.0 -semantic-version==2.6.0 +semantic-version==2.7 toml==0.10.2 urllib3==1.26.18 From 85de3bf0f9caea8dca28497fab08fa3f3b3701ab Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 14:30:22 -0500 Subject: [PATCH 02/18] Revert semantic-version version --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 08d3b06..fd4fc49 100644 --- a/requirements.txt +++ b/requirements.txt @@ -15,6 +15,6 @@ PyJWT==2.4.0 requests==2.31.0 retworkx==0.11.0 scipy==1.10.0 -semantic-version==2.7 +semantic-version==2.6.0 toml==0.10.2 urllib3==1.26.18 From 3dc899d1624d654140ab7dde487d1c7c0e1a1a77 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 14:50:34 -0500 Subject: [PATCH 03/18] Update python version in .readthedocs.yml --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index da55fc5..c9f8f46 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,6 +12,6 @@ python: build: os: ubuntu-22.04 tools: - python: "3.9" + python: "3.10" apt_packages: - graphviz From 0f30435648416a8262b794e58e453d2a17c63bef Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 14:57:14 -0500 Subject: [PATCH 04/18] checking setuptools version --- .readthedocs.yml | 2 +- setup.py | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index c9f8f46..da55fc5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,6 +12,6 @@ python: build: os: ubuntu-22.04 tools: - python: "3.10" + python: "3.9" apt_packages: - graphviz diff --git a/setup.py b/setup.py index f7f33c3..7e73b57 100644 --- a/setup.py +++ b/setup.py @@ -77,4 +77,10 @@ "Topic :: Scientific/Engineering :: Physics", ] +pipVersion = pkg_resources.require("pip")[0].version +setuptoolsVersion = pkg_resources.require("setuptools")[0].version + +print("\n PIP Version", pipVersion, "\n") +print("\n Setuptools Version", setuptoolsVersion, "\n") + setup(classifiers=classifiers, **(info)) From 4a6dc6c5e2976a2428ff248a7655effc1cd2fa85 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 14:58:46 -0500 Subject: [PATCH 05/18] revert --- setup.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/setup.py b/setup.py index 7e73b57..f7f33c3 100644 --- a/setup.py +++ b/setup.py @@ -77,10 +77,4 @@ "Topic :: Scientific/Engineering :: Physics", ] -pipVersion = pkg_resources.require("pip")[0].version -setuptoolsVersion = pkg_resources.require("setuptools")[0].version - -print("\n PIP Version", pipVersion, "\n") -print("\n Setuptools Version", setuptoolsVersion, "\n") - setup(classifiers=classifiers, **(info)) From c01f09c1bd29ec243902cf9be7f8d4e2ffb08129 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 15:03:21 -0500 Subject: [PATCH 06/18] Update conf.py --- doc/conf.py | 269 +++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 222 insertions(+), 47 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 0ae5c19..644c3e3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,7 +1,8 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# PennyLane-Honeywell documentation build configuration file. +# PennyLane documentation build configuration file, created by +# sphinx-quickstart on Tue Apr 17 11:43:51 2018. # # This file is execfile()d with the current directory set to its # containing dir. @@ -11,22 +12,25 @@ # # All configuration values have a default; values that are commented out # serve to show the default. -import sys, os, re +import os +import re +import sys +from datetime import datetime # 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. -sys.path.insert(0, os.path.abspath('..')) -sys.path.insert(0, os.path.abspath('_ext')) -sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), 'doc')) +sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath("_ext")) +sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(".")), "doc")) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = '1.6' +needs_sphinx = "3.3" # Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# extensions coming with Sphinx (named "sphinx.ext.*") or your custom # ones. extensions = [ "sphinx.ext.autodoc", @@ -36,36 +40,71 @@ "sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinx.ext.inheritance_diagram", + "sphinx.ext.viewcode", + "sphinxcontrib.bibtex", + "sphinx.ext.graphviz", "sphinx.ext.intersphinx", - 'sphinx.ext.viewcode', "sphinx_automodapi.automodapi", - 'sphinx_automodapi.smart_resolver' + "sphinx_copybutton", + "sphinxext.opengraph", + "m2r2", ] -intersphinx_mapping = {"https://docs.pennylane.ai/en/stable/": None} +# Open Graph metadata +ogp_social_cards = { + "image": "_static/logo.png", + "enable": True, + "site_url": "https://docs.pennylane.ai/", + "line_color": "#03b2ff", +} +ogp_image = "_static/opengraph.png" + + +# The base URL with a proper language and version. +html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/") + +# Tell Jinja2 templates the build is running on Read the Docs +if os.environ.get("READTHEDOCS", "") == "True": + html_context = {"READTHEDOCS": True} + +os.environ["SPHINX_BUILD"] = "1" autosummary_generate = True autosummary_imported_members = False automodapi_toctreedirnm = "code/api" +automodapi_inheritance_diagram = False automodsumm_inherited_members = True +# Hot fix for the error: 'You must configure the bibtex_bibfiles setting' +bibtex_bibfiles = ["bibfile.bib"] + +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " +copybutton_prompt_is_regexp = True + +intersphinx_mapping = { + "demo": ("https://pennylane.ai/qml/", None), + "catalyst": ("https://docs.pennylane.ai/projects/catalyst/en/stable", None), +} + +mathjax_path = ( + "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML" +) +ignore_warnings = [("code/api/qml_transforms*", "no module named pennylane.transforms")] + # Add any paths that contain templates here, relative to this directory. -from pennylane_sphinx_theme import templates_dir -templates_path = [templates_dir()] +templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'PennyLane-Honeywell' -copyright = "2023, Xanadu Quantum Technologies Inc." -author = 'Xanadu Inc.' +project = "PennyLane" +copyright = f"{datetime.now().year}, Xanadu Quantum Technologies" +author = "Xanadu Inc." add_module_names = False @@ -73,83 +112,219 @@ # |version| and |release|, also used in various other places throughout the # built documents. -import pennylane_honeywell +import pennylane + +pennylane.Hamiltonian = pennylane.ops.op_math.linear_combination.LinearCombination + + # The full version, including alpha/beta/rc tags. -release = pennylane_honeywell.__version__ +release = pennylane.__version__ # The short X.Y version. -version = re.match(r'^(\d+\.\d+)', release).expand(r'\1') +version = re.match(r"^(\d+\.\d+)", release).expand(r"\1") # 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 = "en" +language = None # today_fmt is used as the format for a strftime call. -today_fmt = '%Y-%m-%d' +today_fmt = "%Y-%m-%d" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +todo_include_todos = False # -- 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 = "nature" + +# 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 = {} + +# Add any paths that contain custom themes here, relative to this directory. + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -html_favicon = '_static/favicon.ico' +# html_favicon = "_static/favicon.ico" # 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'] +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +html_extra_path = ["robots.txt"] + +# If not "", a "Last updated on:" timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = "%b %d, %Y" + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True # Custom sidebar templates, must be a dictionary that maps document names # to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +# html_sidebars = { +# "**": [ +# ] +# } + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = "" + +# This is the file name suffix for HTML files (e.g., ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# "da", "de", "en", "es", "fi", "fr", "h", "it", "ja" +# "nl", "no", "pt", "ro", "r", "sv", "tr" +# html_search_language = "en" + +# A dictionary with options for the search language support, empty by default. +# Now only "ja" uses this config value +# html_search_options = {"type": "default"} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = "scorer.js" + +# Output file base name for HTML help builder. +htmlhelp_basename = "PennyLanedoc" # -- Xanadu theme --------------------------------------------------------- -html_theme = 'pennylane' +html_theme = "pennylane" -# xanadu theme options (see theme.conf for more information) +# Xanadu theme options (see theme.conf for more information). html_theme_options = { "navbar_name": "PennyLane-Honeywell", "extra_copyrights": [ - "TensorFlow, the TensorFlow logo, and any related marks are trademarks " - "of Google Inc." + "TensorFlow, the TensorFlow logo, and any related marks are trademarks " "of Google Inc." ], - "toc_overview": True, - "google_analytics_tracking_id": "G-C480Z9JL0D" + "google_analytics_tracking_id": "G-C480Z9JL0D", } -edit_on_github_project = 'PennyLaneAI/pennylane-honeywell' -edit_on_github_branch = 'master/doc' +edit_on_github_project = "PennyLaneAI/pennylane" +edit_on_github_branch = "master/doc" + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ("letterpaper" or "a4paper"). + # + # "papersize": "letterpaper", + # The font size ("10pt", "11pt" or "12pt"). + # + # "pointsize": "10pt", + # Additional stuff for the LaTeX preamble. + # + # "preamble": "", + # Latex figure (float) alignment + # + # "figure_align": "htbp", +} -#============================================================ +latex_additional_files = ["macros.tex"] -# the order in which autodoc lists the documented members -autodoc_member_order = 'bysource' +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, "PennyLane.tex", "PennyLane Documentation", "Xanadu Inc.", "manual"), +] -# inheritance_diagram graphviz attributes -inheritance_node_attrs = dict(color='lightskyblue1', style='filled') -#autodoc_default_flags = ['members'] -autosummary_generate = True +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "pennylane", "PennyLane Documentation", [author], 1)] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "PennyLane", + "PennyLane Documentation", + author, + "PennyLane", + "Xanadu quantum machine learning library.", + "Miscellaneous", + ), +] + +# ============================================================ + +# the order in which autodoc lists the documented members +autodoc_member_order = "bysource" + +# remove types from function signatures +autodoc_typehints = "none" + +# inheritance_diagram graphviz attributes +inheritance_node_attrs = dict(color="lightskyblue1", style="filled") From 0e592e7f5ddfaba5f0bec411df88baeee8918dc3 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 15:12:36 -0500 Subject: [PATCH 07/18] Revert --- doc/conf.py | 268 +++++++++------------------------------------------- 1 file changed, 46 insertions(+), 222 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 644c3e3..8385bcb 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,8 +1,7 @@ #!/usr/bin/env python3 # -*- coding: utf-8 -*- # -# PennyLane documentation build configuration file, created by -# sphinx-quickstart on Tue Apr 17 11:43:51 2018. +# PennyLane-Honeywell documentation build configuration file. # # This file is execfile()d with the current directory set to its # containing dir. @@ -12,25 +11,22 @@ # # All configuration values have a default; values that are commented out # serve to show the default. -import os -import re -import sys -from datetime import datetime +import sys, os, re # 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. -sys.path.insert(0, os.path.abspath("..")) -sys.path.insert(0, os.path.abspath("_ext")) -sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(".")), "doc")) +sys.path.insert(0, os.path.abspath('..')) +sys.path.insert(0, os.path.abspath('_ext')) +sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath('.')), 'doc')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "3.3" +needs_sphinx = '1.6' # Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named "sphinx.ext.*") or your custom +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ "sphinx.ext.autodoc", @@ -40,71 +36,36 @@ "sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinx.ext.inheritance_diagram", - "sphinx.ext.viewcode", - "sphinxcontrib.bibtex", - "sphinx.ext.graphviz", "sphinx.ext.intersphinx", + 'sphinx.ext.viewcode', "sphinx_automodapi.automodapi", - "sphinx_copybutton", - "sphinxext.opengraph", - "m2r2", + 'sphinx_automodapi.smart_resolver' ] -# Open Graph metadata -ogp_social_cards = { - "image": "_static/logo.png", - "enable": True, - "site_url": "https://docs.pennylane.ai/", - "line_color": "#03b2ff", -} -ogp_image = "_static/opengraph.png" - - -# The base URL with a proper language and version. -html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/") - -# Tell Jinja2 templates the build is running on Read the Docs -if os.environ.get("READTHEDOCS", "") == "True": - html_context = {"READTHEDOCS": True} - -os.environ["SPHINX_BUILD"] = "1" +intersphinx_mapping = {"https://docs.pennylane.ai/en/stable/": None} autosummary_generate = True autosummary_imported_members = False automodapi_toctreedirnm = "code/api" -automodapi_inheritance_diagram = False automodsumm_inherited_members = True -# Hot fix for the error: 'You must configure the bibtex_bibfiles setting' -bibtex_bibfiles = ["bibfile.bib"] - -copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " -copybutton_prompt_is_regexp = True - -intersphinx_mapping = { - "demo": ("https://pennylane.ai/qml/", None), - "catalyst": ("https://docs.pennylane.ai/projects/catalyst/en/stable", None), -} - -mathjax_path = ( - "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML" -) -ignore_warnings = [("code/api/qml_transforms*", "no module named pennylane.transforms")] - # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +from pennylane_sphinx_theme import templates_dir +templates_path = [templates_dir()] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -source_suffix = ".rst" +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' # The master toctree document. -master_doc = "index" +master_doc = 'index' # General information about the project. -project = "PennyLane" -copyright = f"{datetime.now().year}, Xanadu Quantum Technologies" -author = "Xanadu Inc." +project = 'PennyLane-Honeywell' +copyright = "2023, Xanadu Quantum Technologies Inc." +author = 'Xanadu Inc.' add_module_names = False @@ -112,219 +73,82 @@ # |version| and |release|, also used in various other places throughout the # built documents. -import pennylane - -pennylane.Hamiltonian = pennylane.ops.op_math.linear_combination.LinearCombination - - +import pennylane_honeywell # The full version, including alpha/beta/rc tags. -release = pennylane.__version__ +release = pennylane_honeywell.__version__ # The short X.Y version. -version = re.match(r"^(\d+\.\d+)", release).expand(r"\1") +version = re.match(r'^(\d+\.\d+)', release).expand(r'\1') # 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 +language = "en" # today_fmt is used as the format for a strftime call. -today_fmt = "%Y-%m-%d" +today_fmt = '%Y-%m-%d' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" +pygments_style = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False +todo_include_todos = True # -- 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 = "nature" - -# 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 = {} - -# Add any paths that contain custom themes here, relative to this directory. - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -# html_favicon = "_static/favicon.ico" +html_favicon = '_static/favicon.ico' # 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"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -html_extra_path = ["robots.txt"] - -# If not "", a "Last updated on:" timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = "%b %d, %Y" - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True +html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. -# html_sidebars = { -# "**": [ -# ] -# } - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = "" - -# This is the file name suffix for HTML files (e.g., ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# "da", "de", "en", "es", "fi", "fr", "h", "it", "ja" -# "nl", "no", "pt", "ro", "r", "sv", "tr" -# html_search_language = "en" - -# A dictionary with options for the search language support, empty by default. -# Now only "ja" uses this config value -# html_search_options = {"type": "default"} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = "scorer.js" +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -# Output file base name for HTML help builder. -htmlhelp_basename = "PennyLanedoc" # -- Xanadu theme --------------------------------------------------------- -html_theme = "pennylane" +html_theme = 'pennylane' -# Xanadu theme options (see theme.conf for more information). +# xanadu theme options (see theme.conf for more information) html_theme_options = { "navbar_name": "PennyLane-Honeywell", "extra_copyrights": [ - "TensorFlow, the TensorFlow logo, and any related marks are trademarks " "of Google Inc." + "TensorFlow, the TensorFlow logo, and any related marks are trademarks " + "of Google Inc." ], - "google_analytics_tracking_id": "G-C480Z9JL0D", -} - -edit_on_github_project = "PennyLaneAI/pennylane" -edit_on_github_branch = "master/doc" - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ("letterpaper" or "a4paper"). - # - # "papersize": "letterpaper", - # The font size ("10pt", "11pt" or "12pt"). - # - # "pointsize": "10pt", - # Additional stuff for the LaTeX preamble. - # - # "preamble": "", - # Latex figure (float) alignment - # - # "figure_align": "htbp", + "toc_overview": True, + "google_analytics_tracking_id": "G-C480Z9JL0D" } -latex_additional_files = ["macros.tex"] +edit_on_github_project = 'PennyLaneAI/pennylane-honeywell' +edit_on_github_branch = 'master/doc' -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "PennyLane.tex", "PennyLane Documentation", "Xanadu Inc.", "manual"), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "pennylane", "PennyLane Documentation", [author], 1)] - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "PennyLane", - "PennyLane Documentation", - author, - "PennyLane", - "Xanadu quantum machine learning library.", - "Miscellaneous", - ), -] - - -# ============================================================ +#============================================================ # the order in which autodoc lists the documented members -autodoc_member_order = "bysource" - -# remove types from function signatures -autodoc_typehints = "none" +autodoc_member_order = 'bysource' # inheritance_diagram graphviz attributes -inheritance_node_attrs = dict(color="lightskyblue1", style="filled") +inheritance_node_attrs = dict(color='lightskyblue1', style='filled') + +#autodoc_default_flags = ['members'] +autosummary_generate = True From 8dfcf7594868db34dafd08c1abd0ccbdcf91459c Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 15:16:50 -0500 Subject: [PATCH 08/18] Update requirements.txt to match docs site that builds without error --- doc/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 3c74386..ec39348 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -28,7 +28,8 @@ retworkx==0.11.0 scipy==1.10.0 semantic-version==2.7 snowballstemmer==2.2.0 -sphinx==4.5.0 +sphinx~=3.5.0; python_version < "3.10" +sphinx==4.2; python_version == "3.10" sphinx-automodapi==0.14.1 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 From 21324ba6bb20aca94b84df5a29cec96c02ec581f Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 15:47:33 -0500 Subject: [PATCH 09/18] Revert requirements.txt change --- doc/requirements.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index ec39348..e8cbdfb 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -28,8 +28,7 @@ retworkx==0.11.0 scipy==1.10.0 semantic-version==2.7 snowballstemmer==2.2.0 -sphinx~=3.5.0; python_version < "3.10" -sphinx==4.2; python_version == "3.10" +Sphinx==4.5.0 sphinx-automodapi==0.14.1 sphinxcontrib-applehelp==1.0.2 sphinxcontrib-devhelp==1.0.2 From c6431ba42aa6afb4f8d2c8c29891fb9e3ee43b6d Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 13 Jan 2025 15:50:03 -0500 Subject: [PATCH 10/18] Upgrade packaging --- doc/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index e8cbdfb..4b09ff1 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -16,7 +16,7 @@ MarkupSafe==2.1.1 networkx==2.8 ninja==1.10.2.3 numpy==1.22.3 -packaging==21.3 +packaging==24.2 pennylane==0.30.0 PennyLane-Lightning==0.30.0 Pygments==2.15.0 From fca613c248bbde523b4427b4d538988d85c6ccab Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 11:33:05 -0500 Subject: [PATCH 11/18] Update workflows --- .github/workflows/format.yml | 14 ++++++++++++++ .github/workflows/tests.yml | 20 +++++++++++++++++++- 2 files changed, 33 insertions(+), 1 deletion(-) diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index bde6df1..a950e0d 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -6,8 +6,22 @@ jobs: black: runs-on: ubuntu-latest steps: + - uses: dorny/paths-filter@v3 + id: filter + with: + filters: | + honeywell: + - pennylane_honeywell/** + - tests/** + - .pylintrc + - Makefile + - requirements-ci.txt + - requirements.txt + - setup.py + - uses: actions/checkout@v1 - name: Black Code Formatter + if: steps.filter.outputs.honeywell == 'true' uses: lgeiger/black-action@master with: args: "-l 100 pennylane_honeywell/ --check" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index ff1622a..0358a4e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,28 +11,46 @@ jobs: strategy: matrix: python-version: [3.9, '3.10', '3.11'] - steps: + steps: - name: Cancel Previous Runs uses: styfle/cancel-workflow-action@0.4.1 with: access_token: ${{ github.token }} + - uses: dorny/paths-filter@v3 + id: filter + with: + filters: | + honeywell: + - pennylane_honeywell/** + - tests/** + - .pylintrc + - Makefile + - requirements-ci.txt + - requirements.txt + - setup.py + - uses: actions/checkout@v1 - name: Set up Python + if: steps.filter.outputs.honeywell == 'true' uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies + if: steps.filter.outputs.honeywell == 'true' run: | python -m pip install --upgrade pip pip install -r requirements-ci.txt pip install wheel pytest pytest-cov pytest-mock --upgrade - name: Install Plugin + if: steps.filter.outputs.honeywell == 'true' run: | python setup.py bdist_wheel pip install dist/PennyLane*.whl - name: Run tests + if: steps.filter.outputs.honeywell == 'true' run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov + if: steps.filter.outputs.honeywell == 'true' uses: codecov/codecov-action@v1.0.12 with: file: ./coverage.xml From bb68c9301b35cbc92dfe4f201458a553b7b14a71 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 11:46:50 -0500 Subject: [PATCH 12/18] Bump codecov/codecov-action version --- .github/workflows/tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 0358a4e..f4c1135 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -51,6 +51,6 @@ jobs: run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov if: steps.filter.outputs.honeywell == 'true' - uses: codecov/codecov-action@v1.0.12 + uses: codecov/codecov-action@v4 with: file: ./coverage.xml From fa72a459ed700dc891ed4db041b3f3c9aa927a72 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 11:58:37 -0500 Subject: [PATCH 13/18] Update tests workflow --- .github/workflows/tests.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index f4c1135..2df647d 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -50,7 +50,6 @@ jobs: if: steps.filter.outputs.honeywell == 'true' run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov - if: steps.filter.outputs.honeywell == 'true' uses: codecov/codecov-action@v4 with: file: ./coverage.xml From e139748d31c6f63466139452241a9c69ff777d33 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 13:34:21 -0500 Subject: [PATCH 14/18] Revert changes --- .github/workflows/tests.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2df647d..f4c1135 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -50,6 +50,7 @@ jobs: if: steps.filter.outputs.honeywell == 'true' run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov + if: steps.filter.outputs.honeywell == 'true' uses: codecov/codecov-action@v4 with: file: ./coverage.xml From 4417c2e38a1ca80ffc00dd43b692407f260b4012 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 13:40:37 -0500 Subject: [PATCH 15/18] Adding test codecov.yml --- codecov.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 codecov.yml diff --git a/codecov.yml b/codecov.yml new file mode 100644 index 0000000..4665d09 --- /dev/null +++ b/codecov.yml @@ -0,0 +1,15 @@ +ignore: + - "docs/*" + +codecov: + notify: + after_n_builds: 1 + +comment: + after_n_builds: 1 +coverage: + + status: + project: + default: + threshold: 0.02% \ No newline at end of file From 9b80be711e9001a608036c73174d6b40aca818e3 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 13:53:35 -0500 Subject: [PATCH 16/18] Revert workflow changes --- .github/workflows/format.yml | 14 -------------- .github/workflows/tests.yml | 17 ----------------- codecov.yml | 15 --------------- 3 files changed, 46 deletions(-) delete mode 100644 codecov.yml diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index a950e0d..bde6df1 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -6,22 +6,8 @@ jobs: black: runs-on: ubuntu-latest steps: - - uses: dorny/paths-filter@v3 - id: filter - with: - filters: | - honeywell: - - pennylane_honeywell/** - - tests/** - - .pylintrc - - Makefile - - requirements-ci.txt - - requirements.txt - - setup.py - - uses: actions/checkout@v1 - name: Black Code Formatter - if: steps.filter.outputs.honeywell == 'true' uses: lgeiger/black-action@master with: args: "-l 100 pennylane_honeywell/ --check" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index f4c1135..063b22f 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -16,41 +16,24 @@ jobs: uses: styfle/cancel-workflow-action@0.4.1 with: access_token: ${{ github.token }} - - uses: dorny/paths-filter@v3 - id: filter - with: - filters: | - honeywell: - - pennylane_honeywell/** - - tests/** - - .pylintrc - - Makefile - - requirements-ci.txt - - requirements.txt - - setup.py - uses: actions/checkout@v1 - name: Set up Python - if: steps.filter.outputs.honeywell == 'true' uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies - if: steps.filter.outputs.honeywell == 'true' run: | python -m pip install --upgrade pip pip install -r requirements-ci.txt pip install wheel pytest pytest-cov pytest-mock --upgrade - name: Install Plugin - if: steps.filter.outputs.honeywell == 'true' run: | python setup.py bdist_wheel pip install dist/PennyLane*.whl - name: Run tests - if: steps.filter.outputs.honeywell == 'true' run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov - if: steps.filter.outputs.honeywell == 'true' uses: codecov/codecov-action@v4 with: file: ./coverage.xml diff --git a/codecov.yml b/codecov.yml deleted file mode 100644 index 4665d09..0000000 --- a/codecov.yml +++ /dev/null @@ -1,15 +0,0 @@ -ignore: - - "docs/*" - -codecov: - notify: - after_n_builds: 1 - -comment: - after_n_builds: 1 -coverage: - - status: - project: - default: - threshold: 0.02% \ No newline at end of file From 62e564e19e4faef4c79f1e86d21899e8bd90a5d9 Mon Sep 17 00:00:00 2001 From: Andrew Gardhouse Date: Mon, 20 Jan 2025 13:54:57 -0500 Subject: [PATCH 17/18] Revert workflow changes --- .github/workflows/tests.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 063b22f..ff1622a 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -11,12 +11,11 @@ jobs: strategy: matrix: python-version: [3.9, '3.10', '3.11'] - steps: + steps: - name: Cancel Previous Runs uses: styfle/cancel-workflow-action@0.4.1 with: access_token: ${{ github.token }} - - uses: actions/checkout@v1 - name: Set up Python uses: actions/setup-python@v2 @@ -34,6 +33,6 @@ jobs: - name: Run tests run: python -m pytest tests --cov=pennylane_honeywell --cov-report=term-missing --cov-report=xml -p no:warnings --tb=native - name: Upload coverage to Codecov - uses: codecov/codecov-action@v4 + uses: codecov/codecov-action@v1.0.12 with: file: ./coverage.xml From 21e5c300dae064cac76aa35ae2324948fbe713b1 Mon Sep 17 00:00:00 2001 From: Alex Preciado Date: Tue, 21 Jan 2025 20:49:39 -0500 Subject: [PATCH 18/18] Trigger CI