From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Docstrings and literate programming (good practices?)
Date: Fri, 4 Nov 2022 18:45:33 +0700 [thread overview]
Message-ID: <tk2u0v$t2t$1@ciao.gmane.io> (raw)
In-Reply-To: <CAJcAo8u2joRM-ZCgv7tt52Ug-MonCxSs8h6qsHqXKMex6MKOnQ@mail.gmail.com>
On 04/11/2022 10:03, Samuel Wales wrote:
>
> for example, you have a body of non-literate elisp code, and you have
> a manual. it could be redundant to describe commands and what they do
> and their options, if the docstrings are good.
There is Sphinx in Python world that allows to combine guide pages with
API docs extracted from source files: classes, functions, variables,
modules (files). Some introduction and API reference may work well. I
tried it, but without going deeper I did not manage to achieve the same
quality as I saw for some packages at readthedocs.
https://www.sphinx-doc.org/en/master/
What I miss in texinfo is a feature similar to Intersphinx
https://www.sphinx-doc.org/en/master/usage/quickstart.html#intersphinx
To generate external references in HTML pages, an index file may be
downloaded. As a result anchors in docs or function names are linked to
proper files, anchors are formatted with section names as their description.
https://docs.python.org likely uses another tool, but the approach is
often the same: general description and docstrings.
I think, Org manual published on the web site would benefit from links
to HTML API reference generated from docstrings.
P.S. Pages generated by doxygen may be convenient as well. It is nice to
have details related to functions and classes linked from overview,
design description, a guide how this API should be used. Of course, it
works only if such pages are written and added to doxygen config.
prev parent reply other threads:[~2022-11-04 11:47 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-01 14:07 Docstrings and literate programming (good practices?) Juan Manuel Macías
2022-11-02 7:13 ` Ihor Radchenko
2022-11-02 7:53 ` Dr. Arne Babenhauserheide
2022-11-02 10:43 ` Ihor Radchenko
2022-11-02 12:49 ` Juan Manuel Macías
2022-11-02 13:05 ` Ihor Radchenko
2022-11-02 15:20 ` Juan Manuel Macías
2022-11-03 7:38 ` Ihor Radchenko
2022-11-03 20:54 ` Rudolf Adamkovič
2022-11-04 3:03 ` Samuel Wales
2022-11-04 5:45 ` tomas
2022-11-04 6:39 ` Marcin Borkowski
2022-11-04 7:13 ` Samuel Wales
2022-11-04 8:08 ` tomas
2022-11-04 8:06 ` tomas
2022-11-04 8:49 ` Ihor Radchenko
2022-11-05 2:07 ` Samuel Wales
2022-11-08 4:10 ` Samuel Wales
2022-11-04 11:45 ` Max Nikulin [this message]
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='tk2u0v$t2t$1@ciao.gmane.io' \
--to=manikulin@gmail.com \
--cc=emacs-orgmode@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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
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).