Skip to content

Fix examples path in build_docs PR workflow #8

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 6 commits into from
Oct 16, 2022

Conversation

psobolewskiPhD
Copy link
Member

@psobolewskiPhD psobolewskiPhD commented Oct 15, 2022

Description

The build action appears to be failing, see https://github.com/napari/docs/actions/runs/3254781307 with an error related to the path of the examples:

Extension error:
[52](https://github.com/napari/docs/actions/runs/3254781307/jobs/5343418375#step:9:53)
Example directory /home/runner/work/docs/docs/docs/docs/../../napari/examples does not have a README file with one of the expected file extensions ['.txt', '.md', '.rst']. Please write one to introduce your gallery.
[53](https://github.com/napari/docs/actions/runs/3254781307/jobs/5343418375#step:9:54)
make: *** [Makefile:15: docs-build] Error 2

I try to fix the nesting, because it is tricky: the docs building on napari/napari (also failing at the moment see: https://github.com/napari/napari/actions/runs/3254935774) use this same conf.py. Hence doing the same copy step to ensure the paths are correct. This will fix the failing napari workflow too, because now conf.py should be correct—tested with my forks:
Here's the docs fork, showing the workflow works:
https://github.com/psobolewskiPhD/napari-docs/actions/runs/3255346428
and here's my napari fork, showing that workflow now works with no changes:
https://github.com/psobolewskiPhD/napari/actions/runs/3255523293

Type of change

  • Bug-fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

References

How has this been tested?

  • example: the test suite for my feature covers cases x, y, and z
  • example: all tests pass with my change

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • If I included new strings, I have used trans. to make them localizable.
    For more information see our translations guide.

@github-actions github-actions bot added documentation Improvements or additions to documentation task labels Oct 15, 2022
@psobolewskiPhD psobolewskiPhD added bug Something isn't working and removed documentation Improvements or additions to documentation labels Oct 15, 2022
Copy link
Member

@jni jni left a comment

Choose a reason for hiding this comment

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

I think indeed that this is nicer! 🙏

@jni jni merged commit f090a96 into napari:main Oct 16, 2022
@psobolewskiPhD psobolewskiPhD deleted the psobolewskiPhD-patch-1 branch February 18, 2023 10:38
@psobolewskiPhD psobolewskiPhD added this to the 0.5.0 milestone Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants