8000 sphinx-gallery docs not rendering properly · Issue #10056 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

sphinx-gallery docs not rendering properly #10056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
choldgraf opened this issue Nov 2, 2017 · 3 comments
Closed

sphinx-gallery docs not rendering properly #10056

choldgraf opened this issue Nov 2, 2017 · 3 comments

Comments

@choldgraf
Copy link
Contributor

It looks like a number of the sphinx gallery docs aren't rendering properly because they've got an extra space in the ###### separators. E.g.

http://scikit-learn.org/stable/auto_examples/plot_isotonic_regression.html#sphx-glr-auto-examples-plot-isotonic-regression-py

has this code in it

# #############################################################################
# Fit IsotonicRegression and LinearRegression models

That extra space is preventing the text from being rendered as rST. Just checking to see if this is intentional or not...
@jnothman
Copy link
Member
jnothman commented Nov 2, 2017 via email

@choldgraf
Copy link
Contributor Author

ah ok - if it was intentional feel free to close

@lesteve
Copy link
Member
lesteve commented Nov 3, 2017

I think this was intentional indeed so I am going to close. The reason behind this is that the scikit-learn examples existed before sphinx-gallery had the notebook-like feature. Most of the examples that were using the notebook-like syntax looked a bit off and the simplest thing to do was that to add a space in the line of hashes.

@lesteve lesteve closed this as completed Nov 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jnothman @lesteve @choldgraf
0