search

ros-infrastructure / rosdoc_lite

A light-weight version of rosdoc that does not rely on ROS infrastructure for crawling packages.
10 stars 31 forks source link

disable doxygen searchengine and latex generation #41

Closed dirk-thomas closed 11 years ago

dirk-thomas commented 11 years ago

The current API docs for Groovy are around 26 GB.

By removing the generated searchengine in doxygen (the small search box in the top right corner at e.g. http://docs.ros.org/hydro/api/roscpp/html/index.html) the amount would be significantly reduced to 6.9 GB.

Additionally I am not sure why we generate latex docs in the first place (e.g. http://docs.ros.org/hydro/api/roscpp/html/latex/) - likely because it is the default in doxygen. By disabling this we another 20% in size resulting in only 5.7 GB.

After this has been merged (and all doc jobs have been executed) it must be verified that the already available generated search/latex documentation is actually removed form the server.

dirk-thomas commented 11 years ago

@jack-oquin @tfoote @wjwwood Please provide feedback.

jack-oquin commented 11 years ago

I am not sure what all the implication are, but this seems OK as described.

wjwwood commented 11 years ago

Seems reasonable to me too.

tfoote commented 11 years ago

Saving space in the results will make the rest of our infrastructure easier. Also it should save us time building the docs.

And generating the latex outputs for the website definitely is unused as we don't have any way to get to it. For the local user it might be useful but if you care that much you can always call doxygen yourself. Most users want the html anyway.

+1

dirk-thomas commented 11 years ago

The following files/folders need to be deleted manually:

tfoote commented 11 years ago

What about running the rsync with --delete? That will take care of this and any other subtractions as long as we run in on a specific packages sub-directory for each call.

dirk-thomas commented 11 years ago

The problem is that the whole doc folder is rsynced back with a single command which can therefore not use --delete. I am not sure that it is a good idea to copy each of the N packages (times three for api, changelogs and tags) individually.