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

Fix link formatting and clarify the distinction between Manim versions in index.rst #4131

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

irvanalhaq9
Copy link
Contributor

Overview: What does this pull request change?

This pull request fixes the formatting of the links. Additionally, it clarifies the distinction between Manim versions, highlighting the difference between ManimCE and the original Manim.

Before
Screenshot 2025-01-22 151629

After
Screenshot 2025-01-22 151721

Motivation and Explanation: Why and how do your changes improve the library?

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

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

My bad, I must have missed that the recent change has introduced a markdown-link to our .rst index.

Long-term, I'd like to migrate most .rst files to .md ones (which Sphinx can parse thanks to the MyST parser anyways, but the contribution barrier is much lower with markdown than with rest).

In any case, thanks for fixing this!

@behackl behackl added the documentation Improvements or additions to documentation label Jan 22, 2025
@behackl behackl added this to the v0.19.1 milestone Jan 22, 2025
@behackl behackl merged commit a6990bd into ManimCommunity:main Jan 22, 2025
20 of 21 checks passed
@JasonGrace2282
Copy link
Member

JasonGrace2282 commented Jan 22, 2025

Long-term, I'd like to migrate most .rst files to .md ones (which Sphinx can parse thanks to the MyST parser anyways, but the contribution barrier is much lower with markdown than with rest).

Helpful link: https://docs.readthedocs.io/en/stable/guides/migrate-rest-myst.html#how-to-convert-existing-restructuredtext-documentation-to-myst
Haven't tested it on any project, but it should hopefully take care of most of the brute force work

@irvanalhaq9 irvanalhaq9 deleted the update-manimce-description branch January 22, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants