Discussion forum for David Beazley

ReST formatting issues on GitHub


Hi, I was getting quite confused by the docs at https://github.com/dabeaz/curio/blob/master/docs/reference.rst until I looked at the ReST source and realised that whole chunks of the documentation using custom directives are not being rendered into HTML by github.

Anything like the follow is lost due to the error Unknown directive type "asyncfunction".:

.. asyncfunction:: sleep(seconds)

   Sleep for a specified number of seconds.  If the number of seconds is 0, the
   kernel merely switches to the next task (if any).

Clearly the docs render correctly locally; is that they’re not rendering on GitHub an issue?


It’s unfortunate, but there isn’t really anything we can do about it. We’re
not going to stop having async functions in the docs, and GitHub isn’t
going to start using custom rest extensions, so…

https://curio.readthedocs.io/en/latest should always have a properly
rendered version of the latest docs.