[WIP] Remove notebooks from repo and cleanup doc/readme by rflamary · Pull Request #156 · PythonOT/POT
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>`__ |
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
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters