[Pulp-dev] Markdown docs - pulpcore and plugins

Brian Bouterse bmbouter at redhat.com
Fri May 1 18:59:18 UTC 2020

+1 to pulpcore and pulp_file switching to markdown. It's quicker to write
and easier to read.

Once a few days have passed for any concerns to be raised, if none are,
then how about this for a plan?

1) merge your PR for pulp_file
2) verify that the docs show up on https://pulp-file.readthedocs.io/
3) start into a PR to convert pulpcore documentation to markdown

On Thu, Apr 30, 2020 at 3:01 PM Fabricio Aguiar <fabricio.aguiar at redhat.com>

> 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
> _______________________________________________
> Pulp-dev mailing list
> Pulp-dev at redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20200501/5a677369/attachment.htm>

More information about the Pulp-dev mailing list