From: Vladimir Zhbanov <vzhbanov@gmail.com>
To: guile-user@gnu.org
Subject: Re: extract documentation from (define ...
Date: Mon, 2 Sep 2019 19:22:10 +0300 [thread overview]
Message-ID: <20190902162210.GA1331@newvzh.lokolhoz> (raw)
In-Reply-To: <87tv9vuvfw.fsf@gnu.org>
On Mon, Sep 02, 2019 at 07:19:15AM +0200, Jan Nieuwenhuizen wrote:
> Jesse Gibbons writes:
>
> > I am trying to generate documentation for a project written in guile. I
> > tried "guild doc-snarf" [0] but apparently it only recognizes
> > documentation in double-semicolon comments. A lot of the project is
> > documented in a string like one would document an emacs-lisp function.
> > Is there a program to extract that kind of documentation?
>
> For Emacsy[0] I have used a guild doc-snarf but am now switching to doc
> strings using. See the `wip-doc' branch and esp.
>
> https://git.savannah.nongnu.org/cgit/emacsy.git/tree/scripts/document-module.scm?h=wip-doc
>
> You may want to look at the Makefile.am as well for how it's used.
Cool, thanks!
The only issue i see is no docstrings found for C code
SCM_DEFINE'd Scheme procedures. Probably there might be some
work-around, too (could the optional args of the
module-stexi-documentation() procedure change something here?).
Anyway, I'm pretty happy to see such functionality in Guile :-)
--
Vladimir
(λ)επτόν EDA — https://github.com/lepton-eda
next prev parent reply other threads:[~2019-09-02 16:22 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-01 21:45 extract documentation from (define Jesse Gibbons
2019-09-02 4:20 ` sirgazil via General Guile related discussions
2019-09-02 5:19 ` Jan Nieuwenhuizen
2019-09-02 16:22 ` Vladimir Zhbanov [this message]
2019-09-02 17:50 ` Jan Nieuwenhuizen
2019-09-02 18:01 ` Vladimir Zhbanov
2019-09-04 20:02 ` Mark H Weaver
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/guile/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190902162210.GA1331@newvzh.lokolhoz \
--to=vzhbanov@gmail.com \
--cc=guile-user@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).