* Automatic indexing for objects like in Sphinx
@ 2025-01-29 15:20 juh
0 siblings, 0 replies; only message in thread
From: juh @ 2025-01-29 15:20 UTC (permalink / raw)
To: org-mode-email
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
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2025-01-29 15:21 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-01-29 15:20 Automatic indexing for objects like in Sphinx juh
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).