Commit Graph

63 Commits

Author SHA1 Message Date
Pieter Holtzhausen b492295575 Tutorial 2011-08-19 00:20:34 +02:00
Stefan van der Walt 05f0015867 BUG: Fix sed in docs build script. 2011-03-15 01:54:20 +02:00
Stefan van der Walt 8f8726f0a6 DOC: Update tasks. 2011-03-15 01:46:14 +02:00
Stefan van der Walt 06f8f398bd API: Remove dtype parameter from imread and collections. Remove as_grey from collections. 2010-11-05 14:44:01 +02:00
Stefan van der Walt d3a4d3da9f Fix link to api changes in docs. 2010-08-23 23:02:39 +02:00
Stefan van der Walt 5179113ded DOC: Add place to document API changes. 2010-07-02 18:05:57 -05:00
Stefan van der Walt 59d86c7af3 DOC: Add CellProfiler relicensing announcement. 2010-07-02 12:41:59 -05:00
Stefan van der Walt 03b53f85e6 Add gitwash documentation. 2010-05-26 19:55:12 -07:00
Emmanuelle Gouillart df431c2cb5 Give explicitly the git clone command in the installation notes. 2010-05-26 13:46:15 -07:00
Stefan van der Walt 65d6ab4840 docs: Update api. 2009-12-03 10:02:32 +02:00
Stefan van der Walt ec70fdad48 docs: Add project title to header. 2009-12-03 09:56:12 +02:00
Stefan van der Walt 5f4d939733 docs: Update API. 2009-12-03 09:38:14 +02:00
Stefan van der Walt 6211279c9e docs: Multiple columns in API reference. 2009-12-03 09:37:27 +02:00
Stefan van der Walt 01266b67b8 doc: Update API. 2009-11-12 11:55:50 +02:00
Stefan van der Walt f988c4ac9d docs: Update API. 2009-11-09 00:07:50 +02:00
Stefan van der Walt 11c7987ff1 doc: Update dependencies. 2009-11-08 01:35:15 +02:00
Stefan van der Walt 7f283390d1 Merge branch 'doc' of git://github.com/tonysyu/scikits.image 2009-11-08 01:27:37 +02:00
Stefan van der Walt ce719afeed Add user guide and documentation on plugins. 2009-11-08 01:21:34 +02:00
Tony 13a7b5361e Add list of build requirements 2009-11-04 19:43:13 -05:00
Stefan van der Walt 5033205972 doc: Update github push script. 2009-11-04 11:30:23 +02:00
Stefan van der Walt 6f4c6f010c doc: Update API. 2009-11-03 10:24:32 +02:00
Stefan van der Walt e6ceb81e39 docs: Update API. 2009-11-03 10:04:06 +02:00
Stefan van der Walt 492ee35c92 doc: Add analysis API. 2009-11-03 08:35:41 +02:00
Stefan van der Walt 502351d8cf Merge branch 'coverage' of git://github.com/rgommers/scikits.image 2009-11-03 00:13:21 +02:00
Ralf Gommers 00cf3a841b Fix the description of make coverage. 2009-11-02 20:43:09 +01:00
Stefan van der Walt f1dc10fd62 docs: Backup generated files before switching to docs branch. 2009-11-01 13:45:04 +02:00
Stefan van der Walt d6a4ec89c1 Check that scikit is built before generating docs for upload. 2009-11-01 13:14:56 +02:00
Stefan van der Walt 4dcde1db19 Add new docs API files. 2009-10-31 23:37:07 +02:00
Ralf Gommers dd6b3ee576 Add some docs for 'make coverage'. 2009-10-28 23:09:48 +01:00
Stefan van der Walt 36b4d97769 Generate new API only when the current version of the library is installed, otherwise revert to pre-generated files. [Patch by Helge Reikeras] 2009-10-25 06:26:36 +02:00
Stefan van der Walt d277058ff9 Include auto-generated API files in distribution. 2009-10-22 10:34:41 +02:00
Stefan van der Walt 96efa2a6a5 Docs: In API generator, also recognise extensions. 2009-10-17 12:56:46 +02:00
Ralf Gommers 20031dae08 Fix up API generation.
It uses introspection now instead of parsing the text of .py files.
2009-10-16 11:08:34 +02:00
Ralf Gommers 04b1f3bffb Use same bullet level for functions and classes. 2009-10-16 11:08:34 +02:00
Ralf Gommers 0df02263a1 Clean up title of API reference. 2009-10-16 11:08:34 +02:00
Ralf Gommers c6565e6a56 Remove "Functions" links/headings.
Also some whitespace issues in this file.
2009-10-16 11:08:34 +02:00
Stefan van der Walt e02a639d61 Fix references scikits.gpu -> scikits.image. 2009-10-15 09:01:15 +02:00
Stefan van der Walt 565b32c8ff Update license phrase for plot_directive. 2009-10-14 16:28:11 +02:00
Stefan van der Walt 48937fe85d When pushing docs to github, rename _images to images. 2009-10-14 08:58:10 +02:00
Stefan van der Walt a47a60f8ae Clean up output of plotting directive:
- Do not generate PDFs.
 - Do not copy image to plots dir (Sphinx copies to _images already).
2009-10-14 08:51:25 +02:00
Stefan van der Walt 80a366761c Shorten and comment show_collection example. 2009-10-14 08:02:39 +02:00
Stefan van der Walt c8bb8c6751 Plot_directive: copy source files to output. 2009-10-14 07:48:14 +02:00
Stefan van der Walt d9c206b625 Set plot directory prefix. 2009-10-14 07:08:13 +02:00
Stefan van der Walt 0601ec4b00 Remove dependency on only_directives. 2009-10-14 06:55:33 +02:00
Stefan van der Walt 735f180d4e Add only_directives.py and plot_directive.py from numpy. 2009-10-14 06:50:22 +02:00
Ralf Gommers 7175d7c187 Add support for MPL plots in the docs.
Both inline plots and plots from script files work.

Some things to keep in mind:
- for including scripts from docstrings, use prefix  "../plots/",
  for including scripts in a rst file, use "plots/".
  This is due to the docs being generated from the source/api folder.
- inline plots are not (yet) aware of variables being defined earlier
  in the Examples section.
- we now use the numpydoc sphinx extensions, the original MPL ones can not
  be used because they have no support for the make file and conf.py not
  being in the same folder.

There is one minor thing that does not work yet. The source code link for
plots does not work because for some reason the script files are not
copied to the build dir.
2009-10-14 00:30:07 +02:00
Ralf Gommers abc27268c2 Fix link in top corner to always point to main page. 2009-10-13 14:47:12 +02:00
Stefan van der Walt 64c23ae460 Grab version number from setup.py for docs. 2009-10-09 08:48:14 +02:00
Stefan van der Walt 305a55d44a Add documentation on how to contribute to the SciKit. 2009-10-07 13:01:53 +02:00
Stefan van der Walt d0a01f80dd Only update gh-pages branch when committing new docs. 2009-10-04 12:44:30 +02:00