Menu

Tree [r95] / trunk / htdocs /
 History

HTTPS access


File Date Author Commit
 examples 2003-12-15 jdh2358 [r95] fixed install path problem
 screenshots 2003-11-21 jdh2358 [r84] removed text_themes png
 tut 2003-11-21 jdh2358 [r79] added htdocs to repository
 README 2003-11-21 jdh2358 [r85] added htdocs README
 backends.html.template 2003-11-21 jdh2358 [r80] added some files
 classdocs.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 convert.py 2003-11-21 jdh2358 [r79] added htdocs to repository
 credits.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 fonts.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 footer.html.template 2003-11-21 jdh2358 [r80] added some files
 goals.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 header.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 index.html.template 2003-11-21 jdh2358 [r80] added some files
 installing.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 interactive.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 license.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 matlab_commands.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 matplotlib.afm.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 matplotlib.artist.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 matplotlib.axes.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 matplotlib.backend_bases.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 matplotlib.backends.backend_gd.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 matplotlib.backends.backend_gtk.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 matplotlib.backends.backend_ps.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 matplotlib.backends.backend_template.html.template 2003-11-27 jdh2358 [r91] mminor updates to docs
 matplotlib.backends.backend_wx.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 matplotlib.cbook.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 matplotlib.lines.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 matplotlib.matlab.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 matplotlib.mlab.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 matplotlib.patches.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 matplotlib.transforms.html.template 2003-11-21 jdh2358 [r85] added htdocs README
 process_docs.py 2003-11-21 jdh2358 [r85] added htdocs README
 screenshots.html.template 2003-12-15 jdh2358 [r95] fixed install path problem
 tutorial.html.template 2003-11-21 jdh2358 [r79] added htdocs to repository
 whats_new.html.template 2003-12-05 jdh2358 [r93] resyncing wx
 whats_new_text.py 2003-11-21 jdh2358 [r79] added htdocs to repository

Read Me

The html for the matplotlib web site is generated using yaptu, a
simple (71 lines of code!) but powerful templating engine

  http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52305

All of the web pages are templates, eg, index.html.template in which I
combine arbitrary python data structures with yaptu templating.

process_docs.py is a script to generate the pydocs for the class
   library, and munge the generated output into a format suitable for
   inclusion into the web page.  

convert.py is the workhorse that runs all the templates and generates
  the html with the appropriate headers and footers.

screenshots/makeshots.py is a script that creates all the screenshots
  that can be generated dyamically (some cannot be because, for
  example, they are screenshots of figure windows with the navigation
  toolbar).  Caution, the mri and pcolor screenshots currently take a
  long time to generate because the are high resolution.  Best run on
  a fast computer!

So in a nutshell, here is what you need to do to generate the docs.
  
  1) Make sure the CVS matplotlib tree is in your PYTHONPATH and 
     > cd htdocs

  2) > python process_docs.py

  3) > python convert.py

  4) > cd screenshots
  
  5) > python makeshots.py  # this could take a while for pcolor and  mri

  6) Point your browser at file:///your/dev/matplotlb/htdocs/index.html

You can also run

  # in the matplotlib dev root (doesn't rebuild screenshots)
  > make htmldocs 

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.