[Python-ideas] Add an UML class diagram to the collections.abc module documentation

Wes Turner wes.turner at gmail.com
Tue Jan 2 09:34:58 EST 2018


On Tuesday, January 2, 2018, Yahya Abou 'Imran <
yahya-abou-imran at protonmail.com> wrote:

> At the end of the day, I found that plantuml is the most suitable tool for
> this.
> Graphviz dot is interesting, but it doesn't feel natural to make class
> diagram with it, or at least it's less handy... I could bring several
> arguments to support this, but it's not the topic.
>
> Everybody wanting to try itself is welcome, but, *I* can take the
> commitment to maintain it over the years.
>

https://readthedocs.org/projects/python/

https://github.com/python/cpython/blob/master/Doc/conf.py

https://github.com/python/cpython/blob/master/Doc/library/collections.abc.rst

https://devguide.python.org/#contributing

https://devguide.python.org/docquality/



>
> Here are the 3 svg files witch are my last proposals for the moment:
>
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/
> blob/master/plantuml/base.svg
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/
> blob/master/plantuml/other_collections.svg
> https://gitlab.com/yahya-abou-imran/collections-abc-uml/
> blob/master/plantuml/full.svg
>

Thanks! Wow, now I wish that I had said PNG email attachments and SVG with
fallback to PNG in the Sphinx docs.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-ideas/attachments/20180102/1acfd4ee/attachment.html>


More information about the Python-ideas mailing list