Re: [matplotlib-devel] API Documentation usability

2015-03-04 Thread Fabio Zanini
OK made a pull request with the first changes (1): #4187. Cheers, F On 03/03/2015 10:56 PM, Benjamin Root wrote: > The website is generated by sphinx from the docstrings and other > components in the doc/ directory of the matplotlib project. The file for > the home page can be found: > https://

Re: [matplotlib-devel] API Documentation usability

2015-03-03 Thread Benjamin Root
The website is generated by sphinx from the docstrings and other components in the doc/ directory of the matplotlib project. The file for the home page can be found: https://github.com/matplotlib/matplotlib/blob/master/doc/_templates/index.html By the way, the file for the "Documenting mpl" page i

Re: [matplotlib-devel] API Documentation usability

2015-03-03 Thread Fabio Zanini
Hi Ben, Well, excellent or not I just hope it helps a bit. I can put some effort if people agree that this is useful, though I am quite busy at the moment. Who's currently actually managing the website? Thx! F On 03/03/2015 21:33, Benjamin Root wrote: > This is excellent insight! It should be fa

Re: [matplotlib-devel] API Documentation usability

2015-03-03 Thread Benjamin Root
This is excellent insight! It should be fairly trivial to fix points 1 and 2, and I agree that it would make the page much more inviting to newcomers. Point 3 would take some time. I had never noticed that before. Personally, I think the issue about documentation isn't that it is boring (I actuall

Re: [matplotlib-devel] API Documentation usability

2015-03-03 Thread Fabio Zanini
Dear Thomas, Finally got some time to reply about the docs. My main point is not about the API docs themselves, although they would need some tuning à la MEP10. Rather, as Sebastian's doubts about pyplot/axes shows, I am considering an issue with the non-API part of the docs, i.e. the user guide,

Re: [matplotlib-devel] API Documentation usability

2015-02-16 Thread Thomas Caswell
At risk of sounding defensive, all of the core developers are working mpl on a mostly volunteer basis and only have so much bandwidth. This leads to both thing falling through the cracks (we have close to 100 open PRs, that is _way_ too many) and major re-factors (which every one agrees should be d

Re: [matplotlib-devel] API Documentation usability

2015-02-16 Thread Fabio Zanini
Dear Sebastian, I agree with your impression. I made a pull request for some axis functionality (logit scales) and the PR got lost. I am convinced that: 1. working on things like axes, ticker, scales, locators would be a lot easier with a little refactoring of the code 2. with a more modular cod

[matplotlib-devel] API Documentation usability

2015-02-16 Thread Sebastian Werhausen
I'm a newcomer to the MPL code, and getting an overview is not easy. Especially the API part of the documentation [1] has a lot of room for improvement. The functionality of the MPL sources seems to be scattered quite loosely among the sources and their structure is directly mirrored in the doc. So