Reorder the list of docnames

15 views
Skip to first unread message

Juna Luzi

unread,
Aug 7, 2020, 6:51:41 AM8/7/20
to sphinx-users
The Sphinx documentation mentions that during the env-before-read-docs event, the author is able to reorder the list of docnames. I'm interested in changing the order in which Sphinx reads the docnames right after event #4 here. I'm not entirely sure what the right approach for this is or if it can be done. Any help would be greatly appreciated!

Komiya Takeshi

unread,
Aug 7, 2020, 8:03:17 AM8/7/20
to sphinx...@googlegroups.com
Hi

I think this tutorial helps you. This describes how to handle an event
in your extension.
https://www.sphinx-doc.org/en/master/development/tutorials/todo.html

BTW, what is a goal of reordering? Actually, you can sort the
docnames. But, AFAIK, the order of docnames is not important. The
reading phase is designed to run independently of other documents
(because it might be invoked parallelly). So there is no advantage for
reordering. I don't know why our document mentioned about reordering.
So please let me know your idea.

Thanks,
Takeshi KOMIYA

2020年8月7日(金) 19:51 Juna Luzi <juna...@gmail.com>:
>
> The Sphinx documentation mentions that during the env-before-read-docs event, the author is able to reorder the list of docnames. I'm interested in changing the order in which Sphinx reads the docnames right after event #4 here. I'm not entirely sure what the right approach for this is or if it can be done. Any help would be greatly appreciated!
>
> --
> You received this message because you are subscribed to the Google Groups "sphinx-users" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
> To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/fa9e4078-85cb-47a3-899c-fac08ded518do%40googlegroups.com.

Daniel Scott

unread,
Nov 25, 2020, 10:36:30 PM11/25/20
to sphinx...@googlegroups.com
On Fri, Aug 7, 2020, 3:51 AM Juna Luzi <juna...@gmail.com> wrote:
The Sphinx documentation mentions that during the env-before-read-docs event, the author is able to reorder the list of docnames. I'm interested in changing the order in which Sphinx reads the docnames right after event #4 here. I'm not entirely sure what the right approach for this is or if it can be done. Any help would be greatly appreciated!

--
Reply all
Reply to author
Forward
0 new messages