Re: integrating authored content with generated API docs

Subject: Re: integrating authored content with generated API docs
From: Tom Johnson <tomjohnson1492 -at- gmail -dot- com>
To: Robert Fekete <fekete77 -dot- robert -at- gmail -dot- com>
Date: Fri, 27 May 2016 12:37:42 -0700

This site is a jekyll-swagger hybrid that incorporates generated API docs:
https://developer.epages.com/apps/

I'm not sure how it was built, though.

As far as integrating Javadoc or Doxygen outputs into another output, I'd
say give up this effort now. It's pretty much impossible beyond adding some
pages in Doxygen.

Tom

---------------------
blog: idratherbewriting.com
twitter: tomjohnson
email: tomjohnson1492 -at- gmail -dot- com
cell: 408-540-8562

On Fri, May 27, 2016 at 11:24 AM, Robert Fekete <fekete77 -dot- robert -at- gmail -dot- com>
wrote:

> 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
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as tomjohnson1492 -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

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -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


Follow-Ups:

References:
integrating authored content with generated API docs: From: Robert Lauriston
RE: integrating authored content with generated API docs: From: mbaker
Re: integrating authored content with generated API docs: From: Robert Lauriston
Fwd: integrating authored content with generated API docs: From: Robert Lauriston
Re: integrating authored content with generated API docs: From: Robert Fekete

Previous by Author: Business Rule Catalogue
Next by Author: Re: integrating authored content with generated API docs
Previous by Thread: Re: integrating authored content with generated API docs
Next by Thread: Re: integrating authored content with generated API docs


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads