Path: csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail
From: =?utf-8?q?Felix_Hild=C3=A9n?= <felix.hilden@gmail.com>
Newsgroups: comp.lang.python.announce
Subject: [Python-announce] Introducing sphinx-codeautolink
Date: Wed, 06 Oct 2021 11:48:49 -0000
Lines: 19
Approved: python-announce-list@python.org
Message-ID: <163352092950.20993.5915649561284354399@mail.python.org>
Reply-To: python-list@python.org
Mime-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
X-Trace: news.uni-berlin.de VlI68dWWlpKrTxiUSXfINwNoIhikTWqNnWt3d+ry29yQ==
Authentication-Results: mail.python.org; dkim=none reason="no signature"; dkim-adsp=none (unprotected policy); dkim-atps=neutral
User-Agent: HyperKitty on https://mail.python.org/
X-MailFrom: felix.hilden@gmail.com
X-Mailman-Rule-Hits: emergency
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved
Message-ID-Hash: UQCWBJ3AWQY7MTZIYZYD5OWY2YZHCBAE
X-Message-ID-Hash: UQCWBJ3AWQY7MTZIYZYD5OWY2YZHCBAE
X-Mailman-Approved-At: Wed, 06 Oct 2021 08:36:44 -0400
X-Mailman-Version: 3.3.5
Precedence: list
List-Id: Announcement-only list for the Python programming language <python-announce-list.python.org>
Archived-At: <https://mail.python.org/archives/list/python-announce-list@python.org/message/UQCWBJ3AWQY7MTZIYZYD5OWY2YZHCBAE/>
List-Archive: <https://mail.python.org/archives/list/python-announce-list@python.org/>
List-Help: <mailto:python-announce-list-request@python.org?subject=help>
List-Owner: <mailto:python-announce-list-owner@python.org>
List-Post: <mailto:python-announce-list@python.org>
List-Subscribe: <mailto:python-announce-list-join@python.org>
List-Unsubscribe: <mailto:python-announce-list-leave@python.org>
Xref: csiph.com comp.lang.python.announce:3700

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)