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

Adding suggestion from Jaime and napari version Note #1

Merged
merged 15 commits into from
Dec 5, 2022

Conversation

psobolewskiPhD
Copy link

Description

I've added the suggestion from Jaime
napari#51 (comment)
And the Note about the version.
I fixed the GitHub action to use the proper version. I'm not sure if the other actions also need changing.

YOu can check the build docs in my fork PR:
psobolewskiPhD#3

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.

Copy link

@Czaki Czaki 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 that it could be done better. We cannot substitute in the code block, but we could substitute the whole code block.

obraz

docs/conf.py Show resolved Hide resolved
docs/tutorials/fundamentals/installation.md Outdated Show resolved Hide resolved
psobolewskiPhD and others added 4 commits December 3, 2022 20:00
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
Co-authored-by: Grzegorz Bokota <bokota+github@gmail.com>
@psobolewskiPhD
Copy link
Author

There was a small bug after merging the fix from Czaki where the regular substitution didn't work. I've fixed it. Here's the built docs now:
image
image
Can access here:
https://github.com/psobolewskiPhD/napari-docs/actions/runs/3610147414

@Czaki
Copy link

Czaki commented Dec 3, 2022

Maybe also specify the python version as a variable in conf.py to have same python version everywhere in docs?

@psobolewskiPhD
Copy link
Author

Maybe also specify the python version as a variable in conf.py to have same python version everywhere in docs?

Good idea. I won't be able to get to it till at least Tuesday—traveling the next two days.
Also, maybe it's a bit of scope creep—which admittedly even this PR to the original PR is somewhat—and should be it's own PR?

@Czaki
Copy link

Czaki commented Dec 3, 2022

but in the scope of this PR may be introduced this variable and use, and followup could be to reintroduce it in another place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants