Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure and update references for unified documentation #154

Merged
merged 7 commits into from
Mar 20, 2025
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
Update refs, conf.py
JoelPasvolsky committed Mar 17, 2025
commit ec9c144b5d49c4eb8786c28ca38a40273ffa2c71
8 changes: 2 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -28,10 +28,8 @@ QUBO. This mapping is called a *penalty model*.

.. end_penaltymodel_about

.. todo:: update the following link post-restructure:

For more information, see
`penalty models <https://docs.ocean.dwavesys.com/en/stable/concepts/penalty.html>`_.
`penalty models <https://docs.dwavequantum.com/en/latest/concepts/penalty.html>`_.

Installation
============
@@ -50,10 +48,8 @@ Released under the Apache License 2.0
Contributing
============

.. todo:: update the following link post-restructure:

Ocean's
`contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_
`contributing guide <https://docs.dwavequantum.com/en/latest/ocean/ocean_contribute.html>`_
has guidelines for contributing to Ocean packages.

Release Notes
6 changes: 1 addition & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -23,8 +23,6 @@
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.ifconfig',
'sphinx_design',
'reno.sphinxext',
]

autosummary_generate = True
@@ -38,7 +36,7 @@

add_module_names = False

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'sdk_index.rst']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.rst']

linkcheck_retries = 2
linkcheck_anchors = False
@@ -60,8 +58,6 @@
}
html_sidebars = {"**": ["search-field", "sidebar-nav-bs"]} # remove ads

# TODO: verify the link to dwave docs
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
'qbsolv': ('https://docs.ocean.dwavesys.com/projects/qbsolv/en/latest/', None),
'dwave': ('https://docs.dwavequantum.com/en/latest/', None),
}
2 changes: 0 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -21,7 +21,5 @@ About penaltymodel
Usage Information
=================

.. todo:: add the intersphinx prefix to enable these links for self builds

* :ref:`index_concepts` for terminology
* :ref:`concept_penalty` for more information on penalties.
3 changes: 1 addition & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
pydata-sphinx-theme==0.14.3
sphinx==7.3.7
reno[sphinx]==4.1.0 # keep synced with requirements.txt
sphinx==7.3.7
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ long_description_content_type = text/x-rst
name = penaltymodel
project_urls =
Changes = https://github.com/dwavesystems/penaltymodel/releases
Documentation = https://docs.ocean.dwavesys.com
Documentation = https://docs.dwavequantum.com
Souce Code = https://github.com/dwavesystems/penaltymodel
url = https://github.com/dwavesystems/penaltymodel
version = attr: penaltymodel.__version__