Skip to content

Convert README and CONTRIBUTING to Markdown #1939

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

Merged
merged 5 commits into from
Mar 3, 2024
Merged

Conversation

Cleptomania
Copy link
Member

This converts the README and CONTRIBUTING files in the Git repo to use Markdown as discussed in #1910. These are only displayed on the GitHub repo(and the PyPI page) and are not part of the Sphinx docs build, so there's no real reason for them to stay RST, we don't have a need for the extra complexity it adds to them.

@Cleptomania
Copy link
Member Author

Upon further inspection this actually does get used in the docs directly, I didn't realize we were including this file into the doc build. Need to think about that more.

@einarf einarf added this to the 3.0 mandatory milestone Feb 18, 2024
@einarf
Copy link
Member

einarf commented Feb 18, 2024

Should be easy enough to fix. We can just link to it from the docs. Easy cleanup (TM)

@Cleptomania
Copy link
Member Author

Yeah we should be able to just link to the GitHub page for it in the docs, anyone contributing is gonna have to use GitHub anyways so it's not that wild of a re-direct. I'll push a change to docs page to do this soon.

@Cleptomania
Copy link
Member Author

This is probably ready to go now, but I'll wait for at least @einarf or @pvcraven to give an okay on merging that we're happy with the changes here. Basically removes most any documentation about contributing from the actual docs, and instead directs to the GitHub CONTRIBUTING file, which is now written in Markdown.

Gives us a single source of truth for the contributing guidelines without having to be dependent on the somewhat fragile include of the CONTRIBUTING file into Sphinx(and the incompatibilities between GitHub and Sphinx's rendering of said file).

@Cleptomania Cleptomania merged commit 1856d30 into development Mar 3, 2024
@Cleptomania Cleptomania deleted the rst-to-markdown branch March 3, 2024 09:54
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

Successfully merging this pull request may close these issues.

2 participants