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.

Sign up for GitHub

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

Build Python interface docs in local RTD #152

Merged
merged 5 commits into from
Sep 4, 2020
Merged

Build Python interface docs in local RTD #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f12c1f5
Fix python build in RTD
JoelPasvolsky Sep 1, 2020
26d73f7
Update ocean path
JoelPasvolsky Sep 1, 2020
6d80595
Set minimum sphinx-build version
JoelPasvolsky Sep 1, 2020
00e75e4
Add new python functions: busclique, layout
JoelPasvolsky Sep 4, 2020
8b1d190
Add busclique.busgraph_cache class
JoelPasvolsky Sep 4, 2020
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
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
breathe<4.13.0
sphinx-rtd-theme==0.*
sphinx==1.*
sphinx>=1.8.5
cython>=0.28.5
7 changes: 3 additions & 4 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,9 @@
import subprocess
import os
import sys
# sys.path.insert(0, os.path.abspath('.'))
config_directory = os.path.dirname(os.path.abspath(__file__))
sys.path.insert(0, os.path.abspath(
os.path.join(config_directory, '../../minorminer')))
sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.dirname(config_directory))

_PY2 = sys.version_info.major == 2

Expand Down Expand Up @@ -146,7 +145,7 @@ def setup(app):
# Configuration for intersphinx.
intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
'qbsolv': ('https://docs.ocean.dwavesys.com/projects/qbsolv/en/latest/', None),
'oceandocs': ('https://docs.ocean.dwavesys.com/en/latest/', None),
'oceandocs': ('https://docs.ocean.dwavesys.com/en/stable/', None),
'sysdocs_gettingstarted': ('https://docs.dwavesys.com/docs/latest/', None)}
# -- Options for HTMLHelp output ------------------------------------------

Expand Down
20 changes: 20 additions & 0 deletions docs/source/reference/pythondocs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
Python Interface
================

General Embedding
-----------------

.. autofunction:: minorminer.find_embedding

Clique Embedding
----------------

.. autoclass:: minorminer.busclique.busgraph_cache
.. autofunction:: minorminer.busclique.find_clique_embedding

Layout & Placement Embedding
----------------------------

.. autoclass:: minorminer.layout.layout.Layout
.. autofunction:: minorminer.layout.layout.p_norm
.. autofunction:: minorminer.layout.layout.dnx_layout

.. autoclass:: minorminer.layout.placement.Placement
.. autofunction:: minorminer.layout.placement.intersection
.. autofunction:: minorminer.layout.placement.closest