8000 Doc multi version master by mdboom · Pull Request #1100 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Doc multi version master #1100

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Aug 19, 2012
Merged

Doc multi version master #1100

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ca678a4
Reinstate the manual reference counting as discovered in #1054.
mdboom Aug 3, 2012
8089e04
Merge pull request #1054 from mdboom/doc_build_fail
mdboom Aug 3, 2012
64e64f6
Fix gallery links (#1024)
mdboom Aug 3, 2012
ff883a6
Merge pull request #1024 from mdboom/fix-gallery
mdboom Aug 3, 2012
c9c108e
Fix pythonxy link
mdboom Aug 9, 2012
9745bdd
Update index.html page.
mdboom Aug 10, 2012
3a1c832
Gentler donation language.
mdboom Aug 10, 2012
b60f3ee
Update credits page
mdboom Aug 16, 2012
87f8df3
Add an autogenerated plotting command summary.
mdboom Aug 16, 2012
cd4c335
Fix small typo listing members to exclude
mdboom Aug 16, 2012
5a2d0a6
Add docstring to _setup_plot_info_docstrings
mdboom Aug 17, 2012
fe2e95d
Update credits
mdboom Aug 17, 2012
1057eed
Merge pull request #1067 from mdboom/doc_multi_version
mdboom Aug 17, 2012
a906f58
Remove hard-coded docstring on plotting()
mdboom Aug 17, 2012
fc271b9
Merge remote-tracking branch 'upstream/v1.1.x' into doc_multi_version…
mdboom Aug 17, 2012
f537d1e
Fix hist2d docstring.
mdboom Aug 17, 2012
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update index.html page. 
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.
  • Loading branch information
@mdboom
mdboom committed Aug 10, 2012
commit 9745bdd279e275010fc4be65eff62b1b02284902
Loading
0