Introducing sphinx-codeautolink

sphinx-codeautolink makes documentation code examples clickable. Links to reference documentation are inserted for the functions and classes that the example uses. The key features are: - Minimal setup assuming examples are already valid Python - Backreference table: display all examples that use a definition - Optionally hide import statements or treat examples as concatenated code - Autodoc and intersphinx integrations A live demo is available on our documentation: https://sphinx-codeautolink.rtfd.io sphinx-codeautolink uses the MIT licence, and version 0.3.0 was recently released. Please reach out on GitHub (felix-hilden) or at felix.hilden@gmail.com if you have any questions or suggestions. Thank you for reading and have a wonderful day! <P><A HREF="https://sphinx-codeautolink.rtfd.io"> sphinx-codeautolink 0.3.0</A> - make your code examples clickable (06-Oct-21)
participants (1)
-
Felix Hildén