Generate documentation for DPF

Options
Pernelle Marone-Hitz
Pernelle Marone-Hitz Member, Moderator, Employee Posts: 810
First Comment First Anniversary Ansys Employee Solution Developer Community of Practice Member
edited June 2023 in Structures

How can I generate the documentation for Data Processing Framework DPF?

Tagged:

Best Answer

  • Pernelle Marone-Hitz
    Pernelle Marone-Hitz Member, Moderator, Employee Posts: 810
    First Comment First Anniversary Ansys Employee Solution Developer Community of Practice Member
    Answer ✓
    Options

    In 2020R2, from Mechanical, the documentation can be generated with the following lines of code:

        import mech_dpf
        mech_dpf.setExtAPI(ExtAPI)
        import Ans.DataProcessing as dpf
        mech_dpf.help()
    

    A string is returned in the console to show the folder in which the documentation is saved. It is saved in a .html file that can then be opened in any web browser.

Answers