Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -312,12 +312,6 @@ jobs:
- attach_workspace:
at: dist

- run:
name: install doxygen
command: |
sudo apt update
sudo apt install doxygen

- run:
name: install package and docs dependencies
command: |
Expand All @@ -334,10 +328,10 @@ jobs:
--only-binary :all:

- run:
name: build docs
name: build docs with warnings as error
command: |
. env/bin/activate
make -C docs cpp html
make -C docs html SPHINXOPTS=-W

- store_artifacts:
path: docs/build/html
Expand Down
14 changes: 0 additions & 14 deletions docs/Doxyfile

This file was deleted.

11 changes: 0 additions & 11 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ SPHINXPROJ = dwave
SOURCEDIR = .
BUILDDIR = build

DOXYGEN_OUTPUT_DIRECTORY=$(BUILDDIR)/doxygen/

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Expand All @@ -20,15 +18,6 @@ clean:
-rm -rf $(BUILDDIR)
-rm -rf reference/generated

cpp:
# Note that sphinx's conf.py expects the build directory to be build/
# and unfortunately there isn't an easy way to read the BUILDDIR from the
# conf.py.
# We could do additional env variables, but this is mostly for the benefit
# of the SDK, so we'll leave it be for now.
mkdir $(BUILDDIR) -p
DOXYGEN_OUTPUT_DIRECTORY=$(DOXYGEN_OUTPUT_DIRECTORY) doxygen Doxyfile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
Expand Down
14 changes: 0 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
import subprocess

# -- Project information -----------------------------------------------------

extensions = [
Expand All @@ -22,7 +19,6 @@
'sphinx.ext.ifconfig',

# other extensions
'breathe',
'sphinx_design',
]

Expand Down Expand Up @@ -70,16 +66,6 @@
'dwave.optimization.typing.ArraySymbolLike': 'ArraySymbol | numpy.typing.ArrayLike',
}

# -- Breathe --------------------------------------------------------------

breathe_projects = {
'dwave-optimization': os.path.join(os.path.dirname(os.path.abspath(__file__)), 'build', 'doxygen', 'xml'),
}

# see https://breathe.readthedocs.io/en/latest/readthedocs.html
if os.environ.get('READTHEDOCS', False):
subprocess.call('make cpp', shell=True, cwd=os.path.dirname(os.path.abspath(__file__)))

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

html_theme = "pydata_sphinx_theme"
Expand Down
15 changes: 0 additions & 15 deletions docs/cpp.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/philosophy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Philosophy
==========

`dwave-optimization` and
the `Leap <https://cloud.dwavesys.com/leap/>`_\ |TM| service's quantum-classical
the `Leap <https://cloud.dwavesys.com/leap/>`_\ service's quantum-classical
hybrid nonlinear solver
incorporate features and design principles from each of the following areas:

Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ docs = [
"pydata-sphinx-theme==0.16.1",
"sphinx==8.2.3",
"sphinx-design==0.6.1",
"breathe==4.35.0",
]

[tool.cibuildwheel]
Expand Down