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

Jump to bottom

Py doxygen #539

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

Py doxygen #539

wants to merge 10 commits into from

Commits on May 21, 2021

  1. Experimental testing, py doxygen doesn't appear to work as desired.

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    13824d3 View commit details
    Browse the repository at this point in the history

  2. Tell swig to keep apidocs in doxygen format. 

    Haven't actually tested this.
    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    c835785 View commit details
    Browse the repository at this point in the history

  3. Investigated the USE_SWIG module src, there isn't a way to tell it no… 

    …t to compile the SWIG outputs.

Therefore I implmented this which uses a custom command.

I cautiously think it works, although will require some refactoring and refinement.
    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    801d77f View commit details
    Browse the repository at this point in the history

  4. Revert changes to this file, they should all be redundant now.

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    e1d7049 View commit details
    Browse the repository at this point in the history

  5. Remove incorrect comment.

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    ec4d704 View commit details
    Browse the repository at this point in the history

  6. Revert some other changes.

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    042e369 View commit details
    Browse the repository at this point in the history

  7. Temp revert this, to see if it fixes CI.

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    aae15ca View commit details
    Browse the repository at this point in the history

  8. As that worked, I think we can instead disable the doxygen translate … 

    …flag.
    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    67f7274 View commit details
    Browse the repository at this point in the history

  9. Set pydocs output dir, correct path of .cxx output

    @Robadob
    Robadob committed May 21, 2021
    Configuration menu
    Copy the full SHA
    eae5733 View commit details
    Browse the repository at this point in the history

Commits on May 24, 2021

  1. These changes copy the comments verbatim. 

    So this kind of works, however there are obvious issues where swig is changing the args.

I'm also thinking CI will now die trying to build pyflamegpu, as when I previously had this line in flamegpu.i, it wasn't happy building the cxx.
    @Robadob
    Robadob committed May 24, 2021
    Configuration menu
    Copy the full SHA
    4e5c8ce View commit details
    Browse the repository at this point in the history