8000 [WIP] Update docs to use .. math:: directive by braunmagrin · Pull Request #7804 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

[WIP] Update docs to use .. math:: directive #7804

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
wants to merge 2 commits into from
Closed

[WIP] Update docs to use .. math:: directive #7804

wants to merge 2 commits into from

Conversation

braunmagrin
Copy link
Contributor

Reference Issue

Fixes #6601

What does this implement/fix? Explain your changes.

Update the docs to use Sphinx's .. math:: instead of the plain :: for a better formatting for the equations.

@braunmagrin
Copy link
Contributor Author

I'd be happy to apply this changes to other files once someone reviews this commit. :)

jnothman
jnothman requested changes Nov 1, 2016
View reviewed changes
Copy link
Member
@jnothman jnothman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You will need to handle more of the intricacies of TeX equation typesetting. It is not this simple.

sklearn/linear_model/coordinate_descent.py

.. math::
(1 / (2 * n_samples)) * ||Y - XW||^2_Fro + alpha * ||W||_21
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_Fro won't render correctly. n_samples should be rendered as text. The underscore, if nothing else, is a problem.

@braunmagrin
Copy link
Contributor Author

@jnothman I'm now using the correct LaTeX commands.
But I wasn't able to properly test my changes. Reading the documentation README I saw that make html should build the documentation. It ran to completion but my changes weren't there, e.g. as I've changed the docstring for the lasso_path function, I would expect its page to be updated in my local version but it was not. Do you know which steps I may be missing?

@jnothman jnothman mentioned this pull request Nov 3, 2016
Closed
@jnothman
Copy link
Member
jnothman commented Nov 3, 2016

What path were you looking at after running make html?

@braunmagrin
Copy link
Contributor Author

This one, for example: scikit-learn/doc/_build/html/stable/modules/generated/sklearn.linear_model.lasso_path.html

@jnothman
Copy link
Member
jnothman commented Nov 4, 2016

Your changes are shown when I render the docs on my machine. I don't know what's happening for you, and I haven't worked out why we can't see the docs in the Circle CI build artifacts.

@Morikko
Copy link
Contributor
Morikko commented Feb 22, 2017

@braunmagrin have you plan to continue the pull request or can I take it ?

@Morikko Morikko mentioned this pull request Mar 8, 2017
Closed
@braunmagrin
Copy link
Contributor Author

@Morikko If you still want to, feel free to continue this. (Sorry for taking so long)

@agramfort
Copy link
Member

see #8556

closing

@agramfort agramfort closed this Jun 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jnothman jnothman jnothman requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rewrite equations with latex mode
4 participants
@braunmagrin @jnothman @Morikko @agramfort
0