[Pulp-dev] RFC: Use Napoleon when Writing Docs

Jeff Ortel jortel at redhat.com
Wed Oct 26 21:07:48 UTC 2016

+1 switching to Napoleon.

On 10/17/2016 10:14 AM, Sean Myers wrote:
> I'd love it if we could stop writing docs in the ":param foo:" style. Instead,
> I think that we should use the sphinx extension "napoleon" to write docstrings
> that are *way* more human-readable (in my opinion, at least) while still
> generating good sphinx docs.
> I think Napoleon's page in the sphinx docs explain this pretty well:
> http://www.sphinx-doc.org/en/stable/ext/napoleon.html
> I've got like three more RFCs queued up; I'm trying to be nice and not overload
> pulp-dev with all my crazy ideas simultaneously. :)
> _______________________________________________
> Pulp-dev mailing list
> Pulp-dev at redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 847 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20161026/ac21322e/attachment.sig>

More information about the Pulp-dev mailing list