Skip to content
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

Get rid of recommonmark dependency #2101

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Get rid of recommonmark dependency #2101

wants to merge 22 commits into from

Conversation

achiefa
Copy link
Contributor

@achiefa achiefa commented Jun 5, 2024

This PR addresses #1978.

@achiefa achiefa added the documentation Issues and PRs related to documentation label Jun 5, 2024
@achiefa achiefa self-assigned this Jun 5, 2024
@achiefa achiefa linked an issue Jun 5, 2024 that may be closed by this pull request
@RoyStegeman
Copy link
Member

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

@achiefa
Copy link
Contributor Author

achiefa commented Jun 6, 2024

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
Copy link
Contributor Author

achiefa commented Oct 9, 2024

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.

@RoyStegeman
Copy link
Member

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

@achiefa
Copy link
Contributor Author

achiefa commented Oct 9, 2024

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
Copy link
Contributor Author

achiefa commented Oct 9, 2024

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

@achiefa achiefa marked this pull request as ready for review October 9, 2024 15:33
@RoyStegeman
Copy link
Member

Thanks! I'll have a look next week.

@RoyStegeman
Copy link
Member

Could you also remove it from the dependencies?

@achiefa
Copy link
Contributor Author

achiefa commented Oct 10, 2024

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?

@RoyStegeman
Copy link
Member

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

@achiefa
Copy link
Contributor Author

achiefa commented Oct 14, 2024

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

Copy link
Member

@RoyStegeman RoyStegeman left a comment

Choose a reason for hiding this comment

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

Thanks, looks good!

At some point we should also take care of the (important) warning such as non-existent labels #1360

@RoyStegeman RoyStegeman linked an issue Oct 14, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and PRs related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Get rid of recommonmark dependency Custom covmat tutorial points to a non existing file
2 participants