Menu
I'm newbie using sphinx. It looks pretty good. I have almost documented all my project using autodoc, but I want to change one behavior. Reading the documentation, I've seen this: autodoc_member_order, and want to change to 'bysource' value, the point is, where am I supposed to put this value?
Thanks, and I apologize for my poor English.
Update: I'm using sphinx 0.6.6
878
This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way.
ext. intersphinx – Link to other projects' documentation. New in version 0.5. This extension can generate links to the documentation of objects in external projects, either explicitly through the external role, or as a fallback resolution for any other cross-reference.
Google Drive, Dropbox, Zapier, Google Chrome, and DevDocs are some of the popular tools that integrate with Sphinx. Here's a list of all 5 tools that integrate with Sphinx.
sphinx-apidoc is a tool for automatic generation of Sphinx sources that, using the autodoc extension, document a whole package in the style of other automatic API documentation tools. MODULE_PATH is the path to a Python package to document, and OUTPUT_PATH is the directory where the generated sources are placed.
put
autodoc_member_order = 'bysource'
at the bottom of the config file.
Of course you need version 1.0, as the docs you linked in the question mention:
Changed in version 1.0: Support for
'bysource'.
130
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
