![]() ![]() Unless otherwise specified in footnotes, comparisons are based on the stable versions without any add-ons, extensions or external programs. Please see the individual products' articles for further information. Or look at some examples? -> linking to doxygen.The following tables compare general and technical information for a number of documentation generators. Maybe you want to know more about the inner workings? -> head over to the reference section. To get to know the doxysphinx comment syntax -> see our syntax guide. To link from sphinx documentation directly to doxygen documented symbols -> see our setting up doxylink guide.( Strongly recommended.) Further Recommendation # Recommended Setup # □ Congratulations you’ve completed the quickstart. Now run doxygen, doxysphinx and sphinx and look at the generated documentation. See also the Syntax Guide for a complete documentation on how to comment for doxysphinx. Inside these tags you can write any rst code. / /// Car ( Engine & engine, Color & color ) hint:: /// Rst text can also be included after the params. / /// engine - the engine to use for this Car. The default value is the current working directory. ![]() If nothing is entered, the default value is “doxygen”. which are dynamically generating doxygen configs. This is more like an “expert”-mode which is especially useful when integrating doxysphinx with buildsystems like cmake etc. ![]() an output path where the generated doxygen documentation resides.This is recommended for “beginners” because it will also check the config for doxysphinx compatibility. ![]() a doxygen configuration file (doxyfile).One or many inputs where each input could be either… This should be the directory where sphinx put’s it’s main index.html to. The root of you sphinx output directory tree - where sphinx puts the generated html files to. Often this is the same directory your conf.py is in. The root of your sphinx source/input directory tree. # The tagfile is also needed for the doxylink extension DOT_IMAGE_FORMAT = svg # generates nicer svg images DOT_TRANSPARENT = YES # generate transparent images INTERACTIVE_SVG = YES # to be able to scroll and zoom into big images # if you want to use aliases instead of markdown fences for commenting (see syntax guide) you have to add # something like this (which doesn't hurt either): ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \ endrst=\endverbatim # This allows you to use rst blocks inside doxygen comments with and build SEARCHENGINE = NO # deactivate search engine (as sphinx has it's own search) GENERATE_TAGFILE = //tagfile.xml # generate a tag file # this could be stored anywhere, however we recommend to put it into the # documentation output folder which is the value of the OUTPUT_DIRECTORY variable # + the value of the HTML_OUTPUT variable (your have to expand it for yourself # because doxygen has no mechanism to reference config settings that were defined # beforehand. These settings are optional but strongly recommended (you will be notified in case of some value deviations): If you cannot live with it you could take a Our recommendation is to just gitignore the generated doxygen docs dir. Is just one additional step that takes time and makes things more complicated. Yes, we don’t like that either, but one of our design goals was performance and scanning htmls and correcting links If that isn’t the case for you doxysphinx will complain and exit.īut I don’t want my docs dir to get polluted with generated code! The doxygen html output has to live inside/somewhere below the sphinx source directory (we recommend using something We did this because sphinx will then automatically generate the html files for the rsts at the correct relative location -Īnd no doxygen-documentation-internal links will break - they just stay the same. Right now for each doxygen html output file a rst file is generated with the same name/path but different extension. Why the heck the doxygen output_dir needs to live inside the sphinx docs root? ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |