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
Stefan van der Walt
35a94b760e
Docs: add inheritance diagram extension.
2009-09-24 19:24:36 +02:00
Stefan van der Walt
db4fc44498
Docs: update install and overview.
2009-09-24 18:18:31 +02:00
Stefan van der Walt
aa7e72b683
Docs: add header to table of contents.
2009-09-24 18:18:14 +02:00
Stefan van der Walt
0acc6f9808
Docs: include license directly.
2009-09-24 18:17:52 +02:00
Stefan van der Walt
3e49065bca
Docs: clean up front page.
2009-09-24 18:08:13 +02:00
Stefan van der Walt
6eb6d76c60
Update license in docs.
2009-09-24 17:55:13 +02:00
Stefan van der Walt
0452388ef0
Generate cleaner API reference with autosummary tables.
2009-09-24 17:50:31 +02:00
Stefan van der Walt
efaeef6a47
Add license info to numpy sphinx extensions.
2009-09-24 17:36:45 +02:00
Stefan van der Walt
750190eab9
Script to automatically build and upload docs.
2009-09-24 15:33:24 +02:00
Stefan van der Walt
8c45ca5f54
Add API generation and fix documentation build.
2009-09-24 12:03:48 +02:00
Stefan van der Walt
92f7b0939b
Add numpy-sphinx docs extensions.
2009-09-24 12:00:46 +02:00
Stefan van der Walt
8b2d916120
Add ignores.
2009-09-24 12:00:26 +02:00
Stefan van der Walt
09bc858ec2
Add Sphinx documentation.
2009-08-22 13:01:54 -07:00