Skip to content

[WIP] Remove notebooks from repo and cleanup doc/readme #156

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.

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

Merged
merged 4 commits into from
Apr 22, 2020

Conversation

rflamary
Copy link
Collaborator

No description provided.

@agramfort
Copy link
Collaborator

all the materials is present in the sphinx gallery examples?

@rflamary
Copy link
Collaborator Author

notebooks were identical to the examples and they are available in the doc. I removed the list from the readme because it also requires to be updated. It lead to an heavy and heavy to pull repo when they were updated.

I think it would be nice to put links directly in the itemize at the top of the redame that point toward examples it will reduce the amount of updating work in my opinion.

solver <https://pythonot.github.io/auto_examples/plot_OT_1D.html>`__
for the linear program/ Earth Movers Distance [1] .
- `Conditional
gradient <https://pythonot.github.io/auto_examples/plot_optim_OTreg.html>`__
Copy link
Collaborator

Choose a reason for hiding this comment

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

within sphinx I would not hard code the links but rely on cross refs within sphinx files. Otherwise the old version of the doc will keep linking to new files

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK done,

plus if you type make rdoc the readme.md is converted to readme.rst in the doc with relative path (sed magic).

@rflamary rflamary merged commit e7e485a into master Apr 22, 2020
@rflamary rflamary deleted the rm_notebooks branch April 22, 2020 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants