![]() ![]() # wurfapi options - relative to your docs dir The following: # Append or insert 'wurfapi' in the extensions list Open the conf.py generated by sphinx-quickstart and add the You will need to enter some basic information about your project such Generate the initial Sphinx documentation by running: mkdir docs Install the extension: pip install sphinx To use the extension, the following steps are needed:Ĭreate a virtual environment: Follow the We recommend that you install wurfapi and sphinx in a virtual environment. We currently use wurfapi in the following projects: We prepared the extension for other backends (replacing Doxygen) e.g. We parse the Doxygen XML into an easy to use Python dictionary. We made it easy to use by automatically running Doxygen to generate the We haveīorrowed the idea of templates to make it highly configurable. Unfortunately development of GapsĮssentially we picked up where Gasp let go. The figures are not currently being generated.We wanted to have a configurable and easy to use Sphinx API documentation work/ITK-bld/Utilities/Doxygen/Modules/ITKCommon.dox:24: error: Problems running dot: exit code=127, command='/usr/sbin/dot', arguments='"/work/ITK-bld/Utilities/Doxygen/html/inline_dotgraph_1.dot" -Tsvg -o "/work/ITK-bld/Utilities/Doxygen/html/dot_inline_dotgraph_1.svg"' The other issue with the Doxygen generation/configuration is a “dot” executable issue: Generating dependency graph for group Registrsh: 1: /usr/sbin/dot: not found Uploading the generated files to an archive like S3 or Kitware Data seems like a better location to store the artifice for public consumptions and downloading. I’m not sure linking to the Github Action Artifact is the thing todo. Is it possible to publish and link to the html, xml, and tag tarballs in the output HTML? It looks like there is some work to upload the xml on GitHub Actions.Ĭurrently, the tarball for both the HTML and XML are uploaded as a single Github Artifact named “doxygen”. Options were … omitted from the configuration file. When ITK_DOXYGEN_XML was enabled XML was not being produced. Added () for all new major features (if any)įurther development details if necessary. Added Python wrapping to new files (if any) as described in () Section 9.5 Updated API documentation (or API not changed) No () were made (or the changes have been approved) Proper indents for the modified auto-groupings. The the proces … ses performed in the is fixed to produce the ![]() Please let me know.Īlso there is some specialized javascript code for advanced caching that may no longer be needed with the removal of daily modification of HTML file.įix many methods being documented in Doxygen with wrong strings. I’m not sure if there is any wider interest in using this infrastructure for main ITK Doxygen generation. Unfortunately, the searching does not work currently but there are likely options for Doxygen that should enable the functionality. The GitHub Actions has been successfully updating the gh-pages for over a month now. It also uses a described docker container, a steps so that anyone can easily regenerate and debug the Doxygen generation process. I have created a GitHub repository here: with associated gh-pages here: Minimizing the number of files modified each day enabled regular web caching based on modified time to work, and adds with small daily updated to a git hub pages branch. I recently made some changes with the ITK Doxygen configuration to minimize the about of changes from night to night in the HTML generated by Doxygen.
0 Comments
Leave a Reply. |