Re: DevDocs support for zephyr docs?


Kumar Gala
 

I came across this looking for a tool for offline doc usage. Looks interesting and will see how it works for cmake docs. Thought it might be useful for other developers in offline usage cases.

- k

On Mar 15, 2018, at 12:04 PM, Kinder, David B <david.b.kinder@intel.com> wrote:

No I haven't heard of DevDocs.

What does the Zephyr community think about such a tool (or others such as dash) that present project API documentation to developers?

What would make the Zephyr Project API material more useful?

For example, should we publish the doxygen-generated html public API documentation instead of (or in addition to) the Sphinx-generated rendering found at http://docs.zephyrproject.org/api/api.html?

Or do developers prefer to just "read the code" (header files in particular)?

-- david

-----Original Message-----
From: Kumar Gala [mailto:kumar.gala@linaro.org]
Sent: Thursday, March 15, 2018 9:42 AM
To: Kinder, David B <david.b.kinder@intel.com>
Cc: zephyr-devel@lists.zephyrproject.org
Subject: DevDocs support for zephyr docs?

David,

I was wondering if you’ve ever come across the DevDocs project
https://github.com/Thibaut/devdocs. I wonder what it might take to get
Zephyr docs supported.

- k

Join devel@lists.zephyrproject.org to automatically receive all group messages.