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

Test docs #75

Merged
merged 7 commits into from
Dec 7, 2024
Merged

Test docs #75

merged 7 commits into from
Dec 7, 2024

Conversation

sneakers-the-rat
Copy link
Collaborator

@sneakers-the-rat sneakers-the-rat commented Nov 12, 2024

Fix: #71

To keep the documentation from being broken, let's test the docs - this action builds the docs and raises warnings as errors.

Error from documenting the CLI seems to have come from needing to have matplotlib installed to import anything, which shouldn't be the case - we want matplotlib to be optional bc it's heavy. So i changed that importerror to a check when one attempts to use the streamplotter instead


📚 Documentation preview 📚: https://miniscope-io--75.org.readthedocs.build/en/75/

@sneakers-the-rat sneakers-the-rat added documentation Improvements or additions to documentation devops labels Nov 12, 2024
@coveralls
Copy link
Collaborator

coveralls commented Nov 12, 2024

Coverage Status

coverage: 77.18% (-0.04%) from 77.22%
when pulling bb77216 on docs-tests
into 87487a1 on main.

@sneakers-the-rat sneakers-the-rat marked this pull request as ready for review November 12, 2024 04:34
Copy link
Collaborator

@t-sasatani t-sasatani left a comment

Choose a reason for hiding this comment

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

Looks like this can't break anything. Also, it's technically tested in the experiment-YYYYMMDD branch, so I think it's good.

@t-sasatani t-sasatani merged commit 6e0ca14 into main Dec 7, 2024
16 checks passed
@t-sasatani t-sasatani deleted the docs-tests branch December 13, 2024 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

sphinx-click doesn't document click
3 participants