Do the bullets render fine in the sphinx generated doc?

@agramfort I think it doesn't render properly...

Ref : From scipy's documentation... A similar bulleted list in the documentation was changed to this and later to this...

Adding 2 spaces before - should fix it... Ref gradient_boosting.GradientBoostingClassifier documentation and the corresponding source.

I don't think you need to prefix it with spaces, but may need a blank line before the list.

@lmichelbacher please run:

pip install -U sphinx
cd doc
make html-noplot

and then check the rendered documentation in the doc/_build/ folder.

@ogrisel Thanks for the tip.

I've checked out the patch-2 branch on lmichelbacher/scikit-learn and ran the commands. The Python source file (text.py) does have the modified docstring but for some reason the built docs don't reflect that.

I'm not familiar with sphinx so it might be some noob mistake.

You need to make sure that the development version of scikit-learn is the one used when building the doc. To do so, you can run python setup.py develop in your source folder. Once the doc is build you can uninstall and reinstall the latest stable version of scikit-learn if you prefer not to use the development version otherwise.

OK, that worked.

I've copied the structure of the docstring from the example above but in my case the line above the bullets is rendered in bold. As soon as I've figured out how to fix this I'll amend the commit.

I think you need a newline before the bullets.