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

RFE: drop use m2r2 module #162

Closed
kloczek opened this issue Mar 11, 2023 · 8 comments
Closed

RFE: drop use m2r2 module #162

kloczek opened this issue Mar 11, 2023 · 8 comments

Comments

@kloczek
Copy link

kloczek commented Mar 11, 2023

m2r2 is still not updated for mistune 2.x and this module is only to include .md file. into metadata.

@SethMMorton
Copy link
Owner

This is only used to build the documentation, and is not required for a regular install. Can you please articulate what is the ROI in removing this and then spending the effort to include markdown into the documentation in an alternate manner?

@kloczek
Copy link
Author

kloczek commented Mar 11, 2023

On packaging all python modules if it is sphinx documebtation I'm building it as man page.
Using m2r2 blocks that.
Using m2r2 is kind of overkill beacuse it is poissible to include file into module descriptin without any addonal modules.

@SethMMorton
Copy link
Owner

When I originally needed to add markdown to rst files this was the only way to do it. Based on what you have said it sounds like there is an alternative way possible. Can you please provide instructions on how to do this, or submit a PR to fix it?

@kloczek
Copy link
Author

kloczek commented Mar 11, 2023

@kloczek
Copy link
Author

kloczek commented Apr 17, 2023

gentle ping .. any update? 🤔

@SethMMorton
Copy link
Owner

Would you be willing to submit a PR? I will not have time for this for a while.

@SethMMorton
Copy link
Owner

Actually, I'll just remove the changelog from the docs, and add a link to the changelog in the repo. Should only take a few minutes.

@kloczek
Copy link
Author

kloczek commented Apr 19, 2023

Yep that works 👍
Thank you.

netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this issue Jun 28, 2023
[8.4.0] - 2023-06-19
---

### Changed

- The changelog now only explictly exists in the repository
  (issue [#162](SethMMorton/natsort#162))

### Fixed

- Inputs with spaces near adjascent to the extension are now sorted
  correctly for `os_sorted` on Windows (issues
  [#165](SethMMorton/natsort#165) and
  [#166](SethMMorton/natsort#166))
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

No branches or pull requests

2 participants