Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Changing the location of the index.html file in Doxygen output

I'm using Doxygen to create html output.

I'd like to customize the output so that the index.html file could be more noticeable, since at the moment it is buried half way down a huge list of files in the html output folder.

For example, if it were moved up one directory to be outside of the 'bits and pieces' html files then it would be much more accessible for others who will be looking for it. However, I can't just ass a line of script to copy it to that location, since all of the links it has would break.

If I could configure Doxygen to have the index file go to a different location, or if you can think of another solution to my problem, I'd be grateful for your response.

Thanks

like image 596
user1488804 Avatar asked Aug 22 '12 10:08

user1488804


People also ask

How exclude code from Doxygen?

How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored.

What is Doxygen configuration file?

A configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile , with the default name Doxyfile . It is parsed by doxygen . The file may contain tabs and newlines for formatting purposes.


2 Answers

I would leave the documentation in its place and instead use the meta refresh option of the HTML language. Place a file, for instance called, "Documentation.html" in any folder you want with the following content

<meta http-equiv="REFRESH" content="0;URL=RELATIVE/PATH/TO/index.html">
like image 103
Amirsaman Avatar answered Nov 15 '22 20:11

Amirsaman


As I mention in comments to the OP the easiest solution is probably to create a symbolic link or shortcut to the index.html file generated by doxygen, rather than trying to get doxygen to change the layout of it's output files. This symlink/shortcut can then be placed in the root directory of your project (or elsewhere), pointing to ./html/index/html, and named anything you like to make it obvious to your users what it is.

like image 33
Chris Avatar answered Nov 15 '22 20:11

Chris