Bug 407919 - Add a clean CSS for automatically generated documentation
Summary: Add a clean CSS for automatically generated documentation
Status: RESOLVED FIXED
Alias: None
Product: Mihini
Classification: IoT
Component: Agent (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 7
: P1 normal (vote)
Target Milestone: 0.9 M1   Edit
Assignee: Laurent Barthelemy CLA
QA Contact: Robert Jacolin CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 407924
  Show dependency tree
 
Reported: 2013-05-13 12:42 EDT by Cuero Bugot CLA
Modified: 2013-08-02 04:50 EDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Cuero Bugot CLA 2013-05-13 12:42:43 EDT 
There currently three doc items that are/should be generated in the nightly build:
- Lua API Doc (Lua Documentor)
- C API Doc (Doxygen)
- Agent Internal modules doc

Additionally, Google analytics hooks should be added to the pages so that we get stats in most used docs/APIs
Comment 1 Benjamin Cabé CLA 2013-05-14 18:12:25 EDT 
(In reply to comment #0)
> - Agent Internal modules doc

See http://download.eclipse.org/mihini/doc
Comment 2 Benjamin Cabé CLA 2013-05-14 18:17:54 EDT 
moving back to inbox for addressing Lua and C API doc improvements
Comment 3 Laurent Barthelemy CLA 2013-07-24 10:43:47 EDT 
Finally resolved by commit 14f60e67f8203063c8a2600ddfdcf2ba2d2bb084.

Lua doc is generated here (using mihini-nightly job):
http://download.eclipse.org/mihini/api/lua/

Lua doc contains the Google Analytics header and the CSS has been updated to be closer to colors used in eclipse.org/mihini.


C doc is generated here (using mihini-nightly job):
http://download.eclipse.org/mihini/api/c

C doc contains the Google Analytics header too.
However the C doc CSS had not been updated: the recommended way to do it (using HTML_EXTRA_STYLESHEET doxygen option, see http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_html_extra_stylesheet) is not supported by the doxygen version installed on build.eclipse server.
I think default doxygen CSS fits correctly with colors used in eclipse.org/mihini.