Availability of member-order options
#201
Labels
Comments
|
Thanks for the suggestion. I've added an autoapi_member_order option to configure this behaviour. |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this issue
Aug 24, 2020
v1.4.0 (2020-06-07) ------------------- Features ^^^^^^^^ * `#197 <https://github.com/readthedocs/sphinx-autoapi/issues/197>`: Added ``autoapi.__version__`` and ``autoapi.__version_info__`` attributes for accessing version information. * `#201 <https://github.com/readthedocs/sphinx-autoapi/issues/201>`: (Python) Added the ``autoapi_member_order`` option to allow the order that members are documentated to be configurable. * `#203 <https://github.com/readthedocs/sphinx-autoapi/issues/203>`: (Python) A class without a docstring inherits one from its parent. A methods without a docstring inherits one from the method that it overrides. * `#204 <https://github.com/readthedocs/sphinx-autoapi/issues/204>`: (Python) Added the ``imported-members`` AutoAPI option to be able to enable or disable documenting objects imported from the same top-level package or module without needing to override templates. Bug Fixes ^^^^^^^^^ * `#198 <https://github.com/readthedocs/sphinx-autoapi/issues/198>`: Documentation describes the required layout for template override directories. * `#195 <https://github.com/readthedocs/sphinx-autoapi/issues/195>`: (Python) Fixed incorrect formatting when ``show-inheritance-diagram`` and ``private-members`` are turned on. * `#193 <https://github.com/readthedocs/sphinx-autoapi/issues/193>` and * `#208 <https://github.com/readthedocs/sphinx-autoapi/issues/208>`: (Python) Inheritance diagrams can follow imports to find classes to document. * `#213 <https://github.com/readthedocs/sphinx-autoapi/issues/213>`: (Python) Fixed module summary never showing. Trivial/Internal Changes ^^^^^^^^^^^^^^^^^^^^^^^^ * black shows diffs by default * `#207 <https://github.com/readthedocs/sphinx-autoapi/issues/207>`: Fixed a typo in the code of the golang tutorial.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hello! Hope everything is all right!
I was wondering if sphinx-autoapi has any support for
member-orderconfigurations? I have been using it for a while but could not find anywhere how to order my docs by source; it always uses an alphabetical order.Best regards,
Gustavo.
The text was updated successfully, but these errors were encountered: