Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python.announce > #2489 > unrolled thread

[ann] sphinxcontrib-trio: make sphinx better at documenting functions/methods, esp. for async/await code

Back to article view | Back to comp.lang.python.announce

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  [ann] sphinxcontrib-trio: make sphinx better at documenting functions/methods, esp. for async/await code Nathaniel Smith <njs@pobox.com> - 2017-05-12 01:24 -0700

#2489 — [ann] sphinxcontrib-trio: make sphinx better at documenting functions/methods, esp. for async/await code

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

[toc] | [standalone]

Back to top | Article view | comp.lang.python.announce

csiph-web