Doc multi version master #1100
Merged
Doc multi version master #1100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stix_fonts_demo.py fails with bad refcount
broken links in the gallery
This allows for multiple versions of the matplotlib documentation to be made available. The scheme is that the root documentation (i.e. http://matplotlib.sf.net/) will always be the latest stable version. Other versions of the documentation will be available in subdirectories off of the root (the latest stable version is merely a symlink or redirect back to the root). This is the same convention used by "docs.python.org", as an aside. The index.html page uses some JavaScript to load a little snippet of HTML from "/versions.html" that lists the available versions. "versions.html" is not part of this repository, but is part of the matplotlib.github.com repository and is updated by hand whenever new versions are added or removed from the archive. This approach allows all versions of the documentation to point to all other versions of the documentation. This JavaScript XMLHttpRequest magic doesn't happen when the user is viewing static files on their local machine, and this is a happy coincidence. The perhaps controversial outcome of this change is that the summary list of plotting commands is removed from the front page. For one, we want to steer people toward the version of the documentation that corresponds to the version they are running. Also, this was a manually created list, and has become quite out of date over time. Better, IMHO, to link to the pyplot documentation. This freed up room to move much of the content that existed in the sidebar to the main body, where I feel it's much less buried. I plan to add a lot more external resources and links, so having the room to do this would be very helpful. Adds a "Fork me on Github" banner.
Support multi-version documentation on the website
…_master Conflicts: boilerplate.py lib/matplotlib/image.py lib/matplotlib/pyplot.py
|
Note also: There are a ton of warnings and errors in the master doc build right now. I will create another pull request for that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is #1067 rebased against master. There shouldn't be too much to vet here, except for @pelson's benefit to see how the changes to
boilerplate.pywere handled.There was no need to generate a colormap list in this case, since master already has a correct and autogenerated list of colormaps thanks to the work by @endolith.
It was not possible to generate the
plottingdocstring inboilerplate.py, sinceboilerplate.pydoesn't know about any of the hard-coded functions inpyplot.py(gca,gcfetc.) -- ideally at some point all that stuff should probably be cleaned up, but this is working for now.