I would like to generate a sitemap for my project documentation generated by Doxygen, how can I make it?
Related
I've tried using https://doctoolchain.github.io/docToolchain/ to create an HTML or PDF doc that includes a swagger/openapi yaml file. It looks like the only output for this is into confluence which also requires an additional confluence plugin. Is this the only option at this time? I am able to do other asciidoc and diagram formatting using docToolchain and I'd be very happy to include swagger. I can publish to confluence but cannot get either of the swagger plugins added to our system.
Beside being able to publish it to confluence, you could generate HTML or PDF files.
For this to work it is necessary to configure it properly and to execute command for generating respective output format (generateHTML|generatePDF). Currently, result will be static (no interactive Swagger-UI page, so you will not be able to make any requests from generated output).
Regarding configuration, you would need to declare location of OpenAPI spec as json file in config.groovy, like:
openApi.with {
specFile = 'src/docs/petstore-v2.0.yaml'
infoUrl = 'https://my-api.company.com'
infoEmail = 'info#company.com'
}
InfoUrl and InfoEmail are just meta parameters which will be used for the HTML/PDF header.
Interactive SwaggerUI generation via docToolchain is one of the features we would like to implement soon, but unfortunately we can't give any ETA at the moment. Nevertheless, PRs at github project are welcomed :)
I am using doxygen to generate docs on some java file written by someone else.
I need to generate doc only for my added or updated api or field. Please suggest if this is possible.
I have a library documented with Doxygen. It's doxyFile contains
GENERATE_TAGFILE = build/doc/mylib/mylib.tag
Doxygen generates the documentation and tagfile without complaint.
I have a package also documented with Doxygen. I want the package documentation to refer to the library documentation. The package doxyFile contains
TAGFILES = build/doc/mylib/mylib.tag=../../mylib/html
Doxygen reports
Reading and parsing tag files
Reading tag file `build/doc/mylib/mylib.tag', location `../../mylib/html'...
Apart from some warnings about duplicate anchors
/Users/mark/Projects/github/Foo/build/doc-x/mylib/mylib.tag:800: warning: Duplicate anchor vdiparam found
Doxygen completes without a problem. However the generated package doc does not include any references to the external library documentation.
What am I doing wrong? Do I have to put explicit links in the package documentation? If so, how?
What I want is to have an entry in the first level of the left-pane treeview of the package docs that links to the library doc's main page.
Let's suppose that I have a file named my_python_code.py, and I upload it to GitHub's gist. Now I embed that gist into my blog, using the code provided by GitHub on the corresponding page.
When I browse my blog and I check the source code for the page, I discover that:
the embed code calls a js file which performs some DocumentWrite commands, inserting the appropriate html tags (with css styles) on my page, and
the associated css file is linked to my page. This file contains css declarations for 'gist' class as well as other classes.
This is all very nice. But I wonder: starting from the same my_python_code.py file, what would I have to do to end up with the same final html code?
I've tried using pygments and rouge (via pygmentize and rougify commands) with reasonable options but none of them highlights the original code using 'gist' tags (among others) as is done when performing the GitHub embed.
I am working on a project that is heavily documented with doxygen.
In a UI I have a list of all the classes available - I would like to be able to open the right documentation page of the class I select. In order to do that I need an easy to read link, so I can dynamically build it and run it.
Is it there any way I can control the generated link of the html file? Because the ones I have right now are impossible do be built dynamically.
You could use Doxygen's tag file mechanism for that (see GENERATE_TAGFILE in the config file).
A tag file is a reasonably easy to understand and parse XML file that basically lists all symbols in your project, with for each symbol the corresponding (relative) URL to the documentation.
So you could parse the tag file from your UI to resolve the links to the doxygen generated documentation in a robust way.