TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: integrating authored content with generated API docs
Subject:Re: integrating authored content with generated API docs From:Robert Fekete <fekete77 -dot- robert -at- gmail -dot- com> To:Robert Lauriston <robert -at- lauriston -dot- com> Date:Fri, 27 May 2016 20:24:07 +0200
Hi,
depending on what programming language your API is, you might try to look
for something similar to Sphinx for Python ( http://www.sphinx-doc.org/en/stable/)
It can autogenerate docs from code comments, and you can also add static
pages (and IIRC, also some structure).
Kind Regards,
Robert
On Tue, May 24, 2016 at 11:28 PM, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:
> It appears to encapsulate the Doxygen output as an attachment. API doc
> pages turn up in the search, but it doesn't look like you can comment
> on them.
>
> > Have you looked into the Doxygen for Confluence plugin?
>
>https://www.appfusions.com/display/DOXYGEN/Home
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as fekete77 -dot- robert -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
