Remove pandoc dependency#397
Open
Mayank447 wants to merge 3 commits intoqutip:masterfrom
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes the Pandoc dependency from the documentation build by switching the tutorials index generation from an HTML→RST conversion workflow to directly generating native RST from a Jinja template.
Changes:
- Added a native
tutorials.rst.jinjatemplate and removed the oldtutorials.html.jinjatemplate. - Updated the tutorials index generator script to render RST directly (eliminating the Pandoc conversion step).
- Removed Pandoc references from contributor docs and from the Read the Docs apt package installation.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
doc/source/tutorials-website/tutorials.rst.jinja |
New RST-native Jinja template for the tutorials index page. |
doc/source/tutorials-website/tutorials.html.jinja |
Removed the old HTML template (no longer needed without Pandoc). |
doc/source/tutorials-website/create_tutorials_html.py |
Switched generation from HTML + Pandoc conversion to direct RST rendering. |
doc/source/contribution-docs.rst |
Removed documentation text stating Pandoc is required. |
.readthedocs.yaml |
Removed Pandoc apt installation from the RTD build environment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Pandoc was used for rendering the tutorials page in our documentation to convert html -> rst since sphinx only support html as an output format not input. Replacing the html jinja template with equivalent rst removes the need for Pandoc.
Related issues or PRs
None
AI Tools Usage Disclosure
None