GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Convert CHANGELOG and CONTRIBUTING from .rst to .md by hugovk · Pull Request #277 · python/python-docs-theme

Conversation

@hugovk

@hugovk hugovk commented Oct 24, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Markdown is easier to work with, these files are not used by Sphinx, and this will make it easier to copy and paste the generated changelog from GitHub into the file (and avoid mistakes like #276 (comment)).

📚 Documentation preview 📚: https://python-docs-theme-previews--277.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
hugovk added 2 commits October 24, 2025 18:59
@hugovk
Convert CHANGELOG.rst -> CHANGELOG.md
47a699c
@hugovk
Convert CONTRIBUTING.rst -> CONTRIBUTING.md
db2bd49
StanFromIreland
StanFromIreland approved these changes Oct 27, 2025
View reviewed changes

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

One minor fix and then LGTM. I could find no other faults, and the GitHub render looks fine too.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread CHANGELOG.md Resolved

Uh oh!

There was an error while loading. Please reload this page.
@hugovk @StanFromIreland
Fix link
f0fa5a6 
Co-authored-by: Stan Ulbrych <[email protected]>
StanFromIreland
StanFromIreland approved these changes Oct 27, 2025
View reviewed changes
@AA-Turner

AA-Turner commented Oct 27, 2025

Copy link
Copy Markdown
Member

I think to an extent this is churn, and I do disagree with the premise. I would suggest that a consistency of markup formats within the project matters more than copying-and-pasting into a third party tool (IIRC, GitHub copes with pasting in the rendered HTML, though one has less control).

This seems to be a loosing battle though, and README files have been changed to markdown for various reasons elsewhere, so I won't block this if there's desire to push ahead.

A
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@hugovk
hugovk merged commit c6ef663 into python:main Dec 8, 2025
2 checks passed

Uh oh!

There was an error while loading. Please reload this page.
@hugovk
hugovk deleted the rst-to-md branch December 8, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@hugovk @AA-Turner @StanFromIreland
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.