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

Set upper limit on version of nbconvert #215

Merged
merged 16 commits into from
Feb 8, 2024

Conversation

namurphy
Copy link
Contributor

@namurphy namurphy commented Feb 1, 2024

This PR is to address the following error that started showing up multiple times in our documentation builds:

/home/runner/work/xrtpy/xrtpy/docs/notebooks/data_analysis/Deconvolving_XRT_images.ipynb:137: ERROR: Content block expected for the "raw" directive; none found.

I was able to resolve the error by requiring nbconvert < 7.14. I also tried changing the OS in the GitHub Action from ubuntu-latest to macos-latest and upgrading to the most recent version of pandoc, but neither of those changes got rid of the error.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Comment on lines 94 to 103
- name: Install pandoc
run: |
# Specify the desired version of Pandoc
PANDOC_VERSION="3.1.11.1" # Update this to the version you need
# Download the pre-built binary package for Linux
wget https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-1-amd64.deb
# Install the downloaded package
sudo dpkg -i pandoc-${PANDOC_VERSION}-1-amd64.deb
# Remove the downloaded package file
rm pandoc-${PANDOC_VERSION}-1-amd64.deb
Copy link
Contributor Author

@namurphy namurphy Feb 2, 2024

Choose a reason for hiding this comment

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

Hm...updating to the most recent release of pandoc still leads to the same error.

I got this step with help from ChatGPT.

...while adding some backticks
Comment on lines +94 to +100
- name: Install pandoc
run: |
PANDOC_VERSION="3.1.11.1"
wget -q https://github.com/jgm/pandoc/releases/download/${PANDOC_VERSION}/pandoc-${PANDOC_VERSION}-1-amd64.deb
sudo dpkg -i pandoc-${PANDOC_VERSION}-1-amd64.deb
rm pandoc-${PANDOC_VERSION}-1-amd64.deb
pandoc --version
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This didn't fix the problem, but it did get rid of the warning.

Copy link
Contributor

Choose a reason for hiding this comment

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

I will create an issue to ensure that we do not overlook this matter, as it could have a significant impact in the future.

@namurphy namurphy changed the title Attempt to address documentation error Set upper limit on version of nbconvert Feb 2, 2024
@namurphy namurphy requested a review from joyvelasquez February 2, 2024 23:53
Copy link
Contributor

@joyvelasquez joyvelasquez left a comment

Choose a reason for hiding this comment

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

This helps bypass the documentation failure. We'll revisit this issue soon. Thanks @namurphy

@namurphy namurphy merged commit 29dbda9 into HinodeXRT:main Feb 8, 2024
10 checks passed
@namurphy namurphy deleted the doc-error-raw-directive branch February 8, 2024 22:34
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