Skip to content

Ignore rendered examples for linting #188

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

Merged
merged 2 commits into from
Apr 21, 2023
Merged

Conversation

PicoCentauri
Copy link
Collaborator

@PicoCentauri PicoCentauri commented Apr 17, 2023

Rendered examples of sphinx-gallery where also tested by the linters.

This unwanted behavior was causing errors locally of the linting is run after the docs where build.


📚 Documentation preview 📚: https://scikit-matter--188.org.readthedocs.build/en/188/

"matplotlib": ("https://matplotlib.org/stable/", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"pandas": ("https://pandas.pydata.org/docs/", None),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does this allow a correct linking of external libraries in the in-code doc?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, but it should be done already. I just did the sorting of the librariers in alphabetical order to be consistent.

"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
Copy link
Collaborator

Choose a reason for hiding this comment

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

maybe you add into your final commit message that you add viewcode? or is this related to the linting

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No sorry, I have to add this.

Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not related to the linting, right? So I wondered if you can just mention this in your commit message when you squash, that you add viewcode?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah okay sorry it is already two commits. Okay forget what I said. Everything fine.

@PicoCentauri PicoCentauri force-pushed the ignore-docs-examples branch from 255a9aa to 3d9f923 Compare April 17, 2023 14:09
Copy link
Collaborator

@agoscinski agoscinski 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 adding viewcode!

@PicoCentauri PicoCentauri merged commit 45cff6a into main Apr 21, 2023
@PicoCentauri PicoCentauri deleted the ignore-docs-examples branch April 21, 2023 09:50
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