[Matplotlib-devel] Call notes 29 Jan

[Antony Lee]

I missed the discussion about the docs, so
1. s-g is great for standalone examples but I would also prefer plain rst
for long tutorials (with e.g. vim-restructuredtext I can have both syntax
highlighting of rst parts in rst and python code-blocks in python (and
likewise for other languages) if the file is rst; for a .py file there is
no special recognition of rst markup by the editor).
2. any specific points about "python authoring less than desirable" for
rst?  what functionalities would be desirable?
  possible relevant links (some already mentioned above):
https://nbsphinx.readthedocs.io/en/0.3.1/
https://github.com/ngoldbaum/RunNotebook
https://github.com/matthew-brett/nb2plots

Antony

2018-01-31 13:10 GMT-08:00 Jody Klymak <jklymak at uvic.ca>:

> More call notes, this time from a more definitive source @tacaswell!
>
> - discussion about how to manage
> - discussion about docs
>   - TAC: we have money to organize a mini-conference (from active state)
>   - EF: are we settled enough to do this? Do we want to leave it more
> dynamic?
>     - discoverability is mostly just google
>       - our API is overly complicated and organically grown
>       - major barrier to discoverability / usability
>     - maybe we want to clean up the API (aggressively?) first
>     - leads to questions about to define the agenda of mini-workshop
>   - JK: need an intermediate between what we have and a 200 page book
>     - need to order the sphinx-gallery entries
>   - EF: consider reverting the tutorials as sphinx-gallery
>     - need more control of ordering, but works well for examples
>     - wrong tool for tutorials
>     - look into sphinx-notebook
>     - move back to plain sphinx?
>   - TAC: we need to develop agenda for mini-workshop that addresses the
> above
>   - EF: before workshop is there a way to gather user requirements?
>     - TAC: user interviews, plausible, may also be part of work, can start
> now.
>     - JK: we can start collecting comments ahead of time
>       - JK will work on managing this!
>
> > On 31 Jan 2018, at 10:41, Jody Klymak <jklymak at uvic.ca> wrote:
> >
> > Hi all,
> >
> > Call notes from Monday’s call.
> >
> > Cheers,   Jody
> >
> >
> > On call: Thomas, Eric, Ryan, Jody, Antony (later half)
> >
> > ## Documentation
> >
> > Thomas reported that there is a fund for a mini-workshop to scope out
> documentation changes.  Plan was to use that to write a proposal to fund a
> book.
> >  - Eric expressed some reservations about a book, given the state of
> flux some parts of Matplotlib are in.
> >  - Jody noted that beyond the book, a shorter “getting started” guide on
> the webpage would still be desirable:
> >
> >       ACTION: Jody to co-ordinate a couple of outline documents that
> could start outlining both of these projects before any meeting.
> >
> > There was also some discussion of online documentation technology:
> >  - Notebooks (via nbsphinx: https://nbsphinx.readthedocs.io)
> >       - hard to make PRs with.  Diffs are a mess in GitHub.
> >      - Can’t use emacs (easily)
> >  - RST-based, with plot directive:
> >       - python authoring less than desirable
> >  - Sphinx-gallery based:
> >       - rst authoring less than desirable
> >       - sphinx gallery has very restricted ordering methods (file size
> and alphabetical)
> >
> > ## Release 2.2
> >
> > Various Release-Critical PRs were looked at.
> >
> >
> > --
> > Jody Klymak
> > http://web.uvic.ca/~jklymak/
> >
> >
> >
> >
> >
> > _______________________________________________
> > Matplotlib-devel mailing list
> > Matplotlib-devel at python.org
> > https://mail.python.org/mailman/listinfo/matplotlib-devel
>
> --
> Jody Klymak
> http://web.uvic.ca/~jklymak/
>
>
>
>
>
> _______________________________________________
> Matplotlib-devel mailing list
> Matplotlib-devel at python.org
> https://mail.python.org/mailman/listinfo/matplotlib-devel
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/matplotlib-devel/attachments/20180131/707162af/attachment-0001.html>