Ask Your Question
1

influence order of entries in function documentation

asked 2014-07-24 08:59:35 -0500

this post is marked as community wiki

This post is a wiki. Anyone with karma >750 is welcome to improve it.

The documentation output from Sphinx for my source code has the functions ordered alphabetically large caps first. I would like to have it alphabetically mixed caps in my file. How can I achieve this?

(It appears there is a Sphinx config option named autodoc_member_order that changes it for the whole project but maybe I'm missing something that was added by Sage)

Update: I tried to work around it by naming the lowercase function with initial cap, and making an alias to that but now the function docs are duplicated! Needless to say, I find the limited options in Sphinx very disappointing.

edit retag flag offensive close merge delete

1 answer

Sort by ยป oldest newest most voted
0

answered 2014-07-24 10:02:01 -0500

I don't think this is possible without patching Sphinx. (I think I would actually have a slight preference to set autodoc_member_order(see http://sphinx-doc.org/ext/autodoc.htm...) to "by source", in which case the ordering is what was in the source file.)

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower

Stats

Asked: 2014-07-24 08:59:35 -0500

Seen: 93 times

Last updated: Jul 24 '14