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

Run doxygen on full include dir and provide full C documentation in RTD #167

Merged
merged 2 commits into from
Dec 1, 2020

Conversation

JoelPasvolsky
Copy link
Contributor

Currently RTD generates and displays very partial C documentation:
image

This update runs doxygen on all files under /include and displays namespaces, classes, files, and structs:
image

@JoelPasvolsky
Copy link
Contributor Author

Another option that is more elegant as long as we always want to build C docs for all include files is:

INPUT                  = ../include
...
RECURSIVE              = YES

@JoelPasvolsky
Copy link
Contributor Author

@boothby, if we want to go with this more or less, I've got it working now locally for the SDK too.

@boothby
Copy link
Collaborator

boothby commented Oct 29, 2020

The recursive option certainly seems easier to maintain.

@JoelPasvolsky
Copy link
Contributor Author

I changed to the recursive method. Doxyfile has an EXCLUDE option that can then be used if we do want to exclude some subdirs in the future.

@JoelPasvolsky
Copy link
Contributor Author

The AppVeyor failure is not related to this PR:

File "C:\Python35\lib\site-packages\dwave\embedding\chimera.py", line 109, in find_clique_embedding
    raise ValueError("cannot find a K{} embedding for given Chimera lattice".format(len(nodes)))
ValueError: cannot find a K13 embedding for given Chimera lattice

@boothby
Copy link
Collaborator

boothby commented Oct 30, 2020

yeah... ironic when you test against an older implementation as a reference and discover a bug in it... this is very low on my todo list right now but it's safe to ignore

@arcondello
Copy link
Member

Is this ready to merge? @JoelPasvolsky @boothby

@boothby boothby merged commit 95fcf55 into dwavesystems:main Dec 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants