emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: juh <juh+org-mode@mailbox.org>
To: org-mode-email <emacs-orgmode@gnu.org>
Subject: Automatic indexing for objects like in Sphinx
Date: Wed, 29 Jan 2025 16:20:38 +0100	[thread overview]
Message-ID: <570c92e1-00a1-40d5-94ea-7b6518c6c9e1@mailbox.org> (raw)

Dear all,

I do some software documentation using Sphinx (https://www.sphinx-doc.org/).

When compiling pdfs Sphinx + LaTeX generates a huge index using a semi 
automatic mechanism.

You can eg. do this:

-----

This is my normal text. Now comes the description of a Python module.

.. py:module:: foo

    Description of module foo

This is normal text.
In the next sentence I want to reference the foo description.
Learn more about :py:mod:`foo`.

------

It is quite simple.
You mark something as a specific object and can reference it elsewhere.
Additionally Sphinx builds an index with links to all modules.

And the syntax is extensible, and you could define something like

.. mode:: org-mode

    Description of org-mode.

Late I can reference the description with :mode:`org-mode`.
And it will show up in my index.


I wonder how I could achieve this in org-mode.

The foo description in Sphinx is not a headline but an anchor-reference 
thing.

How could I achieve this in org-mode in a way that it gets exported 
correctly to be of use in Latex or HTML?

Can I make "foo" a subtree with a special tag that triggers the 
anchorization, referencing and indexing?

I know that there are tags and an index mechanism, but I miss the way 
how to chain it all together.

TIA
juh


                 reply	other threads:[~2025-01-29 15:21 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=570c92e1-00a1-40d5-94ea-7b6518c6c9e1@mailbox.org \
    --to=juh+org-mode@mailbox.org \
    --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).