[Pulp-dev] Markdown docs - pulpcore and plugins

Fabricio Aguiar fabricio.aguiar at redhat.com
Thu Apr 30 19:00:34 UTC 2020

Due issue 6518 <https://pulp.plan.io/issues/6518>, about documenting the
python clients,
I searched about how to use markdown on sphinx and found this [1]
This helped me to document pulp_file client [2], currently, it introduces
markdown docs from the client, keeping the pulp_file rst docs.

Instead of getting mixed formats for docs,
I propose we move our current docs to markdown,
please share your thoughts!

[1] https://www.sphinx-doc.org/en/master/usage/markdown.html
[2] https://github.com/pulp/pulp_file/pull/386

Best regards,
Fabricio Aguiar
Software Engineer, Pulp Project
Red Hat Brazil - Latam <https://www.redhat.com/>
+55 11 999652368
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20200430/41d7a43f/attachment.htm>

More information about the Pulp-dev mailing list