statsforecast icon indicating copy to clipboard operation
statsforecast copied to clipboard

[docs] HTML in index notebook messes up online docs

Open jmoralez opened this issue 3 years ago • 5 comments

This is how the docs render locally for me with the latest changes to the readme. I believe this is due to the embedded html, maybe we can try to achieve that formatting without using html.

Screenshot from 2022-02-23 21-25-27

jmoralez avatar Feb 24 '22 03:02 jmoralez

🙈 Yes, it's a mess. In NeuralForecast we decided to follow the convention that the README.md will be changed manually and that index.ipynb will have special content for documentation. What do you think? Maybe we can try to achieve the formatting or follow that convention.

AzulGarza avatar Feb 24 '22 18:02 AzulGarza

It def. has some advantages to have different versions of README.md and index.ipynb. The idea is the former serves as a landing page of the library and the latter as the home page of the documentation. For example I think we should have an all-contributors section in the README but not in the index.

mergenthaler avatar Feb 24 '22 18:02 mergenthaler

I left a note here. It might be useful for solving this issue.

  • https://github.com/Nixtla/statsforecast/pull/24#issuecomment-1052933096

sugatoray avatar Feb 27 '22 01:02 sugatoray

@all-contributors please add @jmoralez maintenance

mergenthaler avatar Mar 08 '22 21:03 mergenthaler

@mergenthaler

I've put up a pull request to add @jmoralez! :tada:

allcontributors[bot] avatar Mar 08 '22 21:03 allcontributors[bot]

Fixed in v1.0.0 (using nbdev2).

AzulGarza avatar Aug 18 '22 21:08 AzulGarza