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

Documentation Bugs #10

Open
tskisner opened this issue Aug 1, 2017 · 0 comments
Open

Documentation Bugs #10

tskisner opened this issue Aug 1, 2017 · 0 comments
Assignees
Labels

Comments

@tskisner
Copy link
Member

tskisner commented Aug 1, 2017

The docs use sphinx, and the C++ code is first passed through doxygen before importing the results using the "breathe" plugin for sphinx. For some reason, using the doxygenclass command from breathe puts both the C++ class docs AND a poorly formatted copy of the corresponding Python class. See for example the source here:

https://github.com/hpc4cmb/tidas/blob/master/docs/sphinx/group.rst

and the generated output here:

http://hpc4cmb.github.io/tidas/group.html

Looking at the html source it seems like maybe the html div ID for the constructor of the C++ class is getting mixed up with the python class. This makes things ugly and should be fixed.

@tskisner tskisner added the bug label Aug 1, 2017
@tskisner tskisner self-assigned this Aug 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant