Path: csiph.com!fu-berlin.de!uni-berlin.de!not-for-mail From: Nathaniel Smith Newsgroups: comp.lang.python.announce Subject: [ann] sphinxcontrib-trio: make sphinx better at documenting functions/methods, esp. for async/await code Date: Fri, 12 May 2017 01:24:22 -0700 Lines: 22 Approved: python-announce-list@python.org Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" X-Trace: news.uni-berlin.de AZngxlXF/zPTEPiwymPRVAOk2o39JOGqkbV0yK7ApAzw== Return-Path: X-Original-To: python-announce-list@python.org Delivered-To: python-announce-list@mail.python.org X-Spam-Status: OK 0.002 X-Spam-Evidence: '*H*': 1.00; '*S*': 0.00; '(except': 0.05; 'subject:code': 0.05; 'subject:skip:s 10': 0.05; 'methods,': 0.09; 'subject: \n ': 0.13; 'package,': 0.15; 'async': 0.16; 'from:addr:pobox.com': 0.16; 'received:sasl.smtp.pobox.com': 0.16; 'received:smtp.pobox.com': 0.16; 'sphinx,': 0.16; 'sphinx.': 0.16; 'subject:documenting': 0.16; 'subject:make': 0.16; 'this).': 0.16; 'sfxlen:2': 0.16; 'subject:] ': 0.17; 'project,': 0.18; 'extension': 0.20; 'to:2**1': 0.21; 'all,': 0.21; 'received:pobox.com': 0.22; 'wrote': 0.23; 'url:io': 0.23; 'message-id:@mail.gmail.com': 0.24; 'originally': 0.27; 'feature': 0.28; 'to:no real name:2**1': 0.29; 'subject:/': 0.30; 'received:google.com': 0.32; '[1]': 0.32; 'really': 0.33; 'mean': 0.34; 'but': 0.34; 'subject:[': 0.34; "there's": 0.36; 'received:209.85': 0.36; 'url:org': 0.36; 'subject:: ': 0.36; 'subject:-': 0.38; 'received:209': 0.38; 'proto:https': 0.39; 'easier': 0.39; 'to:addr:python.org': 0.39; 'received:io': 0.39; 'received:psf.io': 0.39; 'received:ams1.psf.io': 0.40; 'received:mail1.ams1.psf.io': 0.40; 'smith': 0.63; 'subject:. ': 0.64; 'to:addr:python-announce-list': 0.72; 'subject:better': 0.84 DKIM-Signature: v=1; a=rsa-sha1; c=relaxed; d=pobox.com; h=mime-version :from:date:message-id:subject:to:content-type; s=sasl; bh=9kBWuq BRUTrGX0Z1hZtHxhRnt3c=; b=cUCcf/Fe7lP05aYezX4maQg3LnH6j3JL3jeYNy n/Uj7s5p3GSRgfp8sgNELx72Q0A0bpEcI2lt2TZahcnVJL1BIpU6MjMRA8PfLmMQ a6+HeivgGat4/5uyVb9R0lR9bP0LNOIRSD2R3rkbJ+QW6a+/Mb3u7zOyP1KuAooh AeWUU= DomainKey-Signature: a=rsa-sha1; c=nofws; d=pobox.com; h=mime-version :from:date:message-id:subject:to:content-type; q=dns; s=sasl; b= RRja2Ub+SPQukSJB1loaKJIJ5gzcgFHtYFtBLAMRqP9liw7TZyPuX2EJRAajhWdX FNo8RyjVMaJeQdc4T1CeWr30oo/PtzwqzIbM7SKnkNxcrZMrNkwi7007mJQHGWFC r3NsQbCHjlGf9c831x34HOhMJkcHcmyPWkFIe6qmaCQ= X-Gm-Message-State: AODbwcBG0EmYFx6mzZJEIS3x/O9jvFRR50f6EmUFr13NkK1APuV1/qjL /RYuXsGzzHP0qlHZhA39SW1sWvKAAg== X-Received: by 10.129.125.67 with SMTP id y64mr2122355ywc.228.1494577462895; Fri, 12 May 2017 01:24:22 -0700 (PDT) X-Gmail-Original-Message-ID: X-Pobox-Relay-ID: 67745482-36EC-11E7-9135-61520C78B957-09433513!pb-smtp2.pobox.com X-Mailman-Approved-At: Fri, 12 May 2017 08:31:39 -0400 X-BeenThere: python-announce-list@python.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Announcement-only list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Mailman-Original-Message-ID: Xref: csiph.com comp.lang.python.announce:2489 Hi all, I just released a new package, sphinxcontrib-trio: https://sphinxcontrib-trio.readthedocs.io/ It makes it easier to document many kinds of functions/methods in sphinx, including async functions, abstract methods, generators, etc. I originally wrote it for the trio [1] project, hence the name, but don't let that put you off -- there's nothing about it that's specific to trio, or even to async/await (except that projects that use async/await *really need* an extension like this). Really I think this extension ought to be a standard feature of sphinx. But in the mean time, it's pretty handy. -n [1] https://trio.readthedocs.io -- Nathaniel J. Smith -- https://vorpus.org