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

READY! [Docs] Remove image embed using rst notation #3496

Merged
merged 3 commits into from
Jan 11, 2024

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Jan 9, 2024

Description

Consistency PR to remove {image} and replace with markdown inline embed.

Development notes

Grepped, replaced, rebuilt, inspected. Docs build is here https://kedro--3496.org.readthedocs.build/en/3496/index.html

Developer Certificate of Origin

We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a Signed-off-by line in the commit message. See our wiki for guidance.

If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@stichbury stichbury self-assigned this Jan 9, 2024
@stichbury stichbury added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Jan 9, 2024
@stichbury
Copy link
Contributor Author

stichbury commented Jan 9, 2024

We need to check over these docs once the dependabot changes are made to the docs tools dependencies, just to confirm all is building OK with newer versions of sphinx, mystparser and sphinx-copy.

Edit (11/01): All looks fine to me

@stichbury stichbury changed the title [Docs] Remove image embed using rst notation [Docs] Remove image embed using rst notation -- do not merge until dependabot changes to docs tools are checked Jan 9, 2024
@stichbury stichbury changed the title [Docs] Remove image embed using rst notation -- do not merge until dependabot changes to docs tools are checked READY! [Docs] Remove image embed using rst notation Jan 11, 2024
Copy link
Contributor

@AhdraMeraliQB AhdraMeraliQB left a comment

Choose a reason for hiding this comment

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

TIL how to define alt text in markdown!

Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

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

LGTM!

@astrojuanlu astrojuanlu merged commit 9a5ef57 into main Jan 11, 2024
11 checks passed
@astrojuanlu astrojuanlu deleted the remove-rst-image-inclusion branch January 11, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants