asgiref icon indicating copy to clipboard operation
asgiref copied to clipboard

Docs structure

Open adamchainz opened this issue 5 years ago • 3 comments
trafficstars

I find it weird that asgiref's docs folder documents ASGI, and the asgiref.sync module is documented over in Django (3.1+ only).

I think it would be better to pull the docs for all asgiref functions over into asgiref's docs. The asgiref docs could then have two sections: ASGI, and the asgiref API.

adamchainz avatar May 26 '20 12:05 adamchainz

(Intersphinx can be used from the Django docs to refer over to asgi.readthedocs.io smoothly)

adamchainz avatar May 26 '20 12:05 adamchainz

https://github.com/django/django/pull/11650#discussion_r390361047

felixxm avatar May 26 '20 13:05 felixxm

Yes, this is mostly a legacy of the asgiref docs actually being the ASGI specification website. We should get around to fixing this.

andrewgodwin avatar May 26 '20 16:05 andrewgodwin