Skip to content

Remove pandoc dependency#397

Open
Mayank447 wants to merge 3 commits intoqutip:masterfrom
Mayank447:remove-pandoc
Open

Remove pandoc dependency#397
Mayank447 wants to merge 3 commits intoqutip:masterfrom
Mayank447:remove-pandoc

Conversation

@Mayank447
Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.jinja template and removed the old tutorials.html.jinja template.
  • 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.

Comment thread doc/source/tutorials-website/create_tutorials_html.py Outdated
Comment thread doc/source/tutorials-website/create_tutorials_rst.py
@Mayank447 Mayank447 requested a review from BoxiLi May 4, 2026 23:09
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