nnpdf icon indicating copy to clipboard operation
nnpdf copied to clipboard

Get rid of `recommonmark` dependency

Open achiefa opened this issue 1 year ago • 6 comments

This PR addresses #1978.

achiefa avatar Jun 05 '24 14:06 achiefa

Thanks a lot for starting this! Don't forget to also delete the markdown file you're replacing.

RoyStegeman avatar Jun 06 '24 09:06 RoyStegeman

Don't forget to also delete the markdown file you're replacing.

Yes, I was't sure whether I should've deleted them or not. I was waiting for your feedback, many thanks!

achiefa avatar Jun 06 '24 09:06 achiefa

I'm currently working on this PR. I just want to mention that nested inline markups are currently not possible in reStructuredText, as explained here. There are some workarounds, but they are really ugly and are not worth the effort. Also, the documentation discourages to adopt them. This just to say that, in converting md to rst, I'm not using nested inline markups when dealing with cross-references.

achiefa avatar Oct 09 '24 11:10 achiefa

thanks, it's a bit ugly anyway so that's fine.

RoyStegeman avatar Oct 09 '24 11:10 RoyStegeman

Just to make a note on the last commit (the one addressing the old grids.md). I've converted it to rst, but I think it is outdated.

achiefa avatar Oct 09 '24 14:10 achiefa

Ok, I think I'm done. Please, @RoyStegeman and @scarlehoff could you please check that I didn't forget anything?

achiefa avatar Oct 09 '24 15:10 achiefa

Thanks! I'll have a look next week.

RoyStegeman avatar Oct 10 '24 09:10 RoyStegeman

Could you also remove it from the dependencies?

RoyStegeman avatar Oct 10 '24 09:10 RoyStegeman

I only see dependencies on recommonmark in pyproject.toml and in meta.yaml in the conda-recipe. Should I just remove any recommonmark key from these files?

achiefa avatar Oct 10 '24 10:10 achiefa

Yes exactly, I suspect you will also have to remove the recommonmark settings from some config file if you haven't already.

RoyStegeman avatar Oct 10 '24 11:10 RoyStegeman

Ok, the doc compiles even after that. Here you can find the log of the build (both stdout and stderr). build.log

achiefa avatar Oct 14 '24 14:10 achiefa