hi -- i am just resending my post from the other day, does anybody
understand the following difference about using autodocs to include
members of an automodule vs. an autoclass:
the autodocs for the members (e.g. functions) of an automodule
correspond to their order in the code of that module, while the
autodocs for the members of an autoclass (e.g. methods) appear in
alphabetical order.
i would like to have the members of an autoclass appear in the same
order as they are in the code of that class. can i do this
automatically? e.g. when using:
.. autoclass:: class.name
:members:
please let me know if i am being unclear, thanks a bunch!
elaine
On Aug 31, 6:42 pm, Elaine Angelino <[email protected]> wrote:
> hi there --
>
> i really like using autodocs in sphinx to complement handwritten
> "tutorial-style" docs
>
> when i use ":members:" to include the members of an automodule, the members
> (e.g. functions inside of the module) appear in the documentation in the
> same order in which they appear in the module, e.g. when i write:
>
> .. automodule:: module.name
> :members:
>
> however, when i use ":members:" to include the members of an autoclass, the
> members (e.g. class methods) appear in alphabetical order, e.g. when i
> write:
>
> .. autoclass:: class.name
> :members:
>
> i would really like to have the class methods automatically appear in the
> same order in which they appear in the class. this can be useful when the
> class methods are grouped conceptually.
>
> is there a configuration setting i am not using properly? something else?
>
> thanks for any help!
>
> elaine
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
