Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork8.1k
Reorganise mpl_toolkits documentation#5752
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
tacaswell commentedDec 28, 2015
I am not a fan of putting the external toolkits under the same top-level heading. Maybe add a top-level "Third-party toolkits" section? |
jenshnielsen commentedDec 28, 2015
I not quite sure what you mean. Are you suggesting to move the page from |
tacaswell commentedDec 28, 2015
Yes, something like: |
jenshnielsen commentedDec 28, 2015
👍 |
jenshnielsen commentedDec 29, 2015
I think this should be ready for review. The branch athttp://jenshnielsen.github.io/matplotlib is updated with the result of building156cb7f |
WeatherGod commentedDec 29, 2015
Uhm, pretty sure this isn't the result of your changes, but the logo/banner Using Firefox 43 on Ubuntu. On Tue, Dec 29, 2015 at 9:12 AM, Jens Hedegaard Nielsen <
|
jenshnielsen commentedDec 29, 2015
@WeatherGod Is that any different fromhttp://matplotlib.org/devdocs/? |
WeatherGod commentedDec 29, 2015
No, it is the same on both pages. On Tue, Dec 29, 2015 at 9:41 AM, Jens Hedegaard Nielsen <
|
jenshnielsen commentedDec 29, 2015
It's probably due to#5653 then? |
WeatherGod commentedDec 29, 2015
as for the mpl_toolkits page itself: On Tue, Dec 29, 2015 at 9:12 AM, Jens Hedegaard Nielsen <
|
WeatherGod commentedDec 29, 2015
Most likely, I have posted a comment there. On Tue, Dec 29, 2015 at 9:44 AM, Jens Hedegaard Nielsen <
|
jenshnielsen commentedDec 29, 2015
@WeatherGod I agree that it's a bit redundant but I have not actually changed that around. That is as it has always been. |
jenshnielsen commentedDec 29, 2015
But perhaps we should just remove all the TOCs from that page? |
doc/_templates/index.html Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Needs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Would it make sense to link tohttps://github.com/matplotlib here, since we are encouraging most third-party packages to come under our gh organization?
mdboom commentedDec 29, 2015
Oops -- sorry, I missed that this is still a WIP and the text hasn't been edited. I'll hold off on my grammatical/typographical nitpicks until that's done. |
jenshnielsen commentedDec 29, 2015
Is not WIP any more but by the looks of it most of the typos are in the original text which I have just moved. |
mdboom commentedDec 29, 2015
I see. Should we try to fix those now anyway? I'm happy to just do them as a PR against this one if that's more efficient... |
jenshnielsen commentedDec 29, 2015
We might as well fix obvious typos now. I have tried not to do to many heavy edits but most of the examples could definitely need an edit but the question is how much effort we want to put into this part of the code? |
mdboom commentedDec 29, 2015
I'll spend a few minutes (but no more) fixing obvious typos and submit a PR against this one... |
mdboom commentedDec 29, 2015
Actually, now that I'm understanding the size of this better, I think it's probably best to leave the text as-is for this PR and try to clean it up later. (We really need to devote some real effort to editing the docs for grammar/consistency in a lot of places...) |
jenshnielsen commentedDec 30, 2015
@WeatherGod I have removed the toc trees @mdboom I corrected the typos that you already noted and added a note above the matplotlib organization to thirdpartypackages/index |
jenshnielsen commentedDec 30, 2015
I have added an api changes noted that The few files which were different in |
WeatherGod commentedDec 30, 2015
Has the github.io been updated for the latest changes? On Wed, Dec 30, 2015 at 7:46 AM, Jens Hedegaard Nielsen <
|
jenshnielsen commentedJan 5, 2016
I have uploaded a new preview version tohttp://jenshnielsen.github.io/matplotlibdocs rather thanhttp://jenshnielsen.github.io/matplotlib |
jenshnielsen commentedJan 5, 2016
I think this should be ready to go. The documentation is by no means perfect but I think this is a significant structural improvement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
"fund" --> "found"
jenshnielsen commentedJan 5, 2016
By the way. I'm happy to revet the deprecation of |
doc/mpl_toolkits/index.rst Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
"axisgrid1"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good catch that is embarrassing
WeatherGod commentedJan 5, 2016
I think that's all the typos I can find. I vote for deprecation of axes_grid. It has been a long time coming, and splitting axisartist out in the documentation makes things a lot more understandable. |
WeatherGod commentedJan 5, 2016
This has a +1 from me. Should this be backported to v2.x or should it stay in master? |
jenshnielsen commentedJan 8, 2016
I was not planning to backport it to 2.x but I can be convinced otherwise. Any objections to merging this. It moves around a large number of examples so I would like to merge it before it acquires to many conflicts. |
Reorganise mpl_toolkits documentation
WeatherGod commentedJan 8, 2016
ok, we will leave it in master for now |
These entries were moved from mpl_toolkits to thirdpartpackages onmaster as part ofmatplotlib#5752.
These entries were moved from mpl_toolkits to thirdpartypackages onmaster as part ofmatplotlib#5752.
The mpl_toolkits axes_grid and axisartist documentation is very focused on the axes_grid namespace dispite the fact that this is not recommenced for use. The code has been split into axes_grid1 and axisartist. This PR aims to do the same for the documentation and make the documentation more visible and consistent.
This is WIP because the text still needs some editing for consistency. A tiny bit of functionality is still hidden in axes_grid.parasiteaxis which I plan to more to axesartist.
I am also tempted to move deprecate axes_grid and interested in input to this.
The docs as build by this branch is up athttp://jenshnielsen.github.io/matplotlib