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

DOC: Fix incorrect indentations for a few interactive examples #734

Merged
merged 1 commit into from
Apr 9, 2024

Conversation

agriyakhetarpal
Copy link
Collaborator

@agriyakhetarpal agriyakhetarpal commented Apr 9, 2024

Description

Some of the interactive examples that were manually inserted in #728 with the TryExamples directive available via the jupyterlite-sphinx extension had the wrong indentation (four spaces instead of two), which made them get rendered like this:

image

This PR is a small fix to address this issue (I had just noticed this when debugging certain aspects of #706). This is how they render now locally (correctly):

image

Additional context

The Usage examples have not been converted to an interactive state at this time and most likely also have the same indentation issue; however, this is on my near-term radar. It would require restructuring the pages and possibly using the NotebookLite directive and configuring some CSS attributes for the generated button, instead of adding duplicated import pywt statements to code cells.

Also, it is to be noted that the automatically parsed code blocks do not seem to have been affected with this, so we'll have to be careful when adding the directive to additional places later on.

@agriyakhetarpal agriyakhetarpal changed the title DOC: Fix indentations for a few interactive examples DOC: Fix incorrect indentations for a few interactive examples Apr 9, 2024
@agriyakhetarpal
Copy link
Collaborator Author

Fixed one of the failing doctests, and the example on https://pywavelets--734.org.readthedocs.build/en/734/ref/signal-extension-modes.html is rendering correctly. This should now be ready for review/merging.

Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks for this @agriyakhetarpal!

@rgommers rgommers merged commit 7f27acc into PyWavelets:main Apr 9, 2024
15 checks passed
@rgommers rgommers added this to the v1.7.0 milestone Apr 9, 2024
@agriyakhetarpal agriyakhetarpal deleted the fix-indentation branch April 9, 2024 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants