Commit Graph

109 Commits

Author SHA1 Message Date
Adrin Jalali 69c8967e21 DOC Fix warnings in examples (#12654)
Fixe or suppresses many warnings in examples, including matplotlib complaining about the non-gui backend.
2019-01-17 21:41:13 +11:00
Prabakaran Kumaresshan 2955129128 DOC Update copyright year for 2019 (#12964) 2019-01-12 16:16:06 +08:00
Andreas Mueller 952ef6637a MRG Drop legacy python / remove six dependencies (#12639) 2019-01-03 15:50:05 +02:00
Dowon 3cb31de2e5 DOC Resolve a missing link on the home page (#12847) 2018-12-27 09:49:44 +08:00
Joel Nothman 274ce3a08a DOC use default_role='any' (#12355) 2018-10-15 00:12:10 +08:00
Joel Nothman c564df9634 DOC glossary on n_jobs=None semantics (#11806) 2018-08-14 11:07:27 +03:00
Joel Nothman 14764061f8
[MRG] DOC fix some sphinx warnings (#11241) 2018-06-21 20:43:21 +10:00
Loïc Estève 873c801e4e MNT Use imgconverter sphinx extension for SVG support in latex. (#11106) 2018-05-18 19:11:56 +08:00
Joel Nothman 160693655e DOC better rendering of math in documentation (#10253) 2018-04-16 09:31:34 +02:00
Loïc Estève 4989a95037
MNT make sure to not run plot_stock_market.py by renaming it (#10878)
Temporary fix until we find a replacement for the Google finance data.
2018-03-28 11:06:21 +02:00
Loïc Estève 97523985b3
Mark plot_stock_market.py as expected to fail (#10872)
until we figure out an alternative datasource to Google finance.
2018-03-26 13:19:41 +02:00
Hanmin Qin 2e85c8608c MAINT Update copyright year 2018 (#10456) 2018-01-12 08:27:38 +11:00
Joel Nothman 3e5469eda7 DOC Add permalink icons to glossary terms (#10429) 2018-01-11 09:27:38 +08:00
Joel Nothman 840f632e8f DOC A glossary of concepts and API elements (#9517)
Skeleton for a glossary of concepts and API elements.

This responds to at least three issues:

* Many aspects of scikit-learn API for users and developers are known
  tacitly by core contributors (and the stack overflow crowd), but are
  not written down in a consistent place.
* What is written is in an ad-hoc narrative style which may be useful
  for introduction, but is difficult to refer to and to maintain.
* Parameters such as `n_jobs` and methods like `decision_function` are
  described repeatedly in documentation giving sometimes more sometimes
  less information. This glossary allows us to use "See :term:`the
  glossary <n_jobs>`." so that parameter descriptions in the
  API reference can remain brief (just as not every numpy operation
  needs to describe broadcasting).
2018-01-02 10:14:07 +01:00
Loïc Estève fabb4fe492 DOC: use intersphinx for links in gallery examples (#9909) 2017-10-11 15:41:26 +02:00
Naoya Kanai 6b130f15cf MAINT: remove deprecated sphinx config variables (#8828) 2017-10-10 15:11:58 +02:00
Andreas Mueller 71408e09e4 [MRG] update numpydoc to upstream, include fix for line numbers (#7355) 2017-07-18 19:34:54 +02:00
Sergei Lebedev 2c55551d0b [MRG] Updated plot_stock_market.py to use Google Finance (#9010)
* DOC updated plot_stock_market.py to use Google Finance

The implementations is intentionally very basic not to distract the users
from the example. Specifically unlike ``quotes_historical_yahoo_ochl`` it
does not cache downloaded data.

I also had to remove some symbols because the have no data on Google for
the specified date interval. These are WBA, LMT, KFT and MTU.

Closes #8899

* DOC removed plot_stock_market.py from expected failing examples

* Addressed review comments

* Addressed another pass of review comments
2017-06-07 07:31:10 +02:00
Óscar Nájera 7a23b2493f Update to Sphinx-Gallery v0.1.11 (#8222) 2017-06-06 16:35:24 +02:00
Joel Nothman db25f57781 [MRG+1] Update version dependencies to numpy 1.8.2, scipy 1.13.3 (#8855) 2017-05-24 08:24:04 +10:00
Loïc Estève 97590191fe DOC add plot_stock_market.py to expected failing examples (#8921)
as a stop gap solution until we figure out a longer-term work-around.

Also remove nibabel from conf.py.
2017-05-23 20:27:23 +02:00
Nelson Liu 288827b0d9 [MRG] update copyright years for 2017 (#8138) 2017-01-02 08:45:34 +11:00
Joel Nothman 3f4524e85e [MRG] DOC :issue: role to simplify what's news (#7657) 2016-10-26 00:04:35 +11:00
Gael Varoquaux 1e2b4436f2 MAINT/DOC: pngmath deprecated for sphinx >= 1.4 (#7279)
Fix #7222
2016-08-29 11:43:41 +02:00
Óscar Nájera 83b21a43e3 Sphinx-Gallery has to be loaded after autodoc
Sphinx loads its extensions sequentially as they are specified on the
list. Sphinx-Gallery relies en autodoc to generated the example
thumbnails when auto documenting the API. If autodoc is not loaded
sphinx-gallery skips this step, as it implies the user might not want
it. In this case we need it, so the gallery has to be loaded after
autodoc and autosummary.

The autosummary_generate variable is repeated
2016-08-03 20:23:50 +02:00
Óscar Nájera 4773dbbc4b Remove custom touch to backreferences files
This is now a default in sphinx-gallery v0.1.2
2016-08-03 20:23:50 +02:00
Óscar Nájera d6be865a32 References to examples 2016-08-03 20:23:50 +02:00
Óscar Nájera 7ec54472fd Add carousel
Fix reference link
2016-08-03 20:23:50 +02:00
Óscar Nájera 17885af9b7 conf.py integrate sphinx-gallery 2016-08-03 20:23:50 +02:00
xyguo 9d444c9b5e add doctest extension (#6774) 2016-06-15 13:42:38 +02:00
Okhlopkov Daniil Olegovich 26c66212b3 Update copyright year in the doc footer (2015 → 2016) 2016-03-15 00:20:00 +03:00
Lilian Besson cdca3cfdef Update copyright year in the doc footer (2014 → 2015) 2015-11-05 00:20:45 +01:00
Joel Nothman 99d08b571e DOC organise documentation hierarchy / table of contents 2015-06-12 08:09:41 +10:00
Andreas Mueller 5e4809caa8 Move dev branch to 0.17 2015-03-06 17:55:01 -05:00
Olivier Grisel ff942f9688 MAINT use canonical PEP-440 dev version consistently 2015-03-06 18:10:18 +01:00
Andreas Mueller 72d4d59dbf Generate example rst files for inclusion in docstrings. 2015-03-02 17:17:05 -05:00
Óscar Nájera e079f3837b Remove JS from examples gallery 2014-12-01 23:10:21 +01:00
Joel Nothman 06b57ae5c3 DOC add links to github sourcecode in API reference 2014-07-21 23:27:10 +10:00
Joel Nothman 937f36cba7 DOC show referring examples on API reference pages 2014-07-20 01:32:42 +10:00
Joel Nothman 1e42a6839b DOC link example gallery scripts rather than inline 2014-07-20 01:32:26 +10:00
Olivier Grisel e8cb36f83d MAINT master to 0.16-git
master has 0.16-only commits since the 0.15-branching tag.

New features have to be documented as new features in the 0.16 section.
Bugfixes to be included in the 0.15.0 release have to be cherry-pick'ed in the
0.15.X branch and document in the 0.15 section.
2014-07-14 21:42:06 +02:00
eltermann 9e4e56a079 /s/2013/2014: Updated project copyright date 2014-02-13 17:02:40 -02:00
Jaques Grobler 8a02b4becf add copybutton to code examples 2013-10-14 09:30:22 +02:00
Gael Varoquaux af5e297302 MAINT/DOC: bump docs and rev numbers to 0.15-git 2013-08-08 01:13:06 +02:00
Gilles Louppe a5044639c9 FIX: footer character encoding 2013-07-28 11:15:03 +02:00
Justin Vincent fe52584e83 Got all the doc-tests working 2013-07-10 10:52:25 -04:00
Jaques Grobler 623d52ab44 add optional banner to index page to advertise code sprints 2013-05-23 21:40:25 +02:00
Jaques Grobler 2f2f10218c Switch off survey banner 2013-04-18 11:20:35 +02:00
Andreas Mueller 19beac87ff REL change version to 0.14-git everywhere, update news, support page. 2013-01-21 22:07:26 +01:00
Jaques Grobler 53a9b64c96 Add temporary survey banner 2013-01-21 21:53:57 +01:00