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

Add zenodo link to docs #36

Merged
merged 4 commits into from
Mar 31, 2024
Merged

Add zenodo link to docs #36

merged 4 commits into from
Mar 31, 2024

Conversation

jlaehne
Copy link
Member

@jlaehne jlaehne commented Mar 30, 2024

Progress of the PR

  • Change implemented (can be split into several points),
  • ready for review.

@jlaehne jlaehne added the documentation Improvements or additions to documentation label Mar 30, 2024
Copy link

codecov bot commented Mar 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.07%. Comparing base (8fb9826) to head (2f2c46d).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #36   +/-   ##
=======================================
  Coverage   88.07%   88.07%           
=======================================
  Files          67       67           
  Lines        7276     7276           
  Branches     1179     1179           
=======================================
  Hits         6408     6408           
  Misses        591      591           
  Partials      277      277           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -91,6 +91,8 @@ please use the DOI of the specific version that you have employed. You can
find it by clicking on the DOI badge below.

.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.10252344.svg
:class: sd-bg-transparent
Copy link
Member

Choose a reason for hiding this comment

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

I can't see any difference between this one and the one in doc/citing.rst, which doesn't have it. Could it be browser dependent?
According to https://sphinx-design.readthedocs.io/en/latest/css_classes.html#colors, this is suppose to change the background to transparent right? If so, could the effect be visible on the edges?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, without this there is a gray edge in dark mode. See also hyperspy/holospy#27 (comment)

@ericpre ericpre mentioned this pull request Mar 31, 2024
2 tasks
doc/citing.rst Outdated
@@ -12,4 +12,5 @@ version. If you are citing HoloSpy because you have used it to process data,
please use the DOI of the specific version that you have employed. You can
find it by clicking on the DOI badge below:

To be updated after first release.
.. image:: https://zenodo.org/badge/doi/10.5281/zenodo.10252344.svg
Copy link
Member

Choose a reason for hiding this comment

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

Similarly as in hyperspy/holospy#27, maybe this page can be removed since this is already in in the intro.rst page?

Copy link
Member Author

@jlaehne jlaehne Mar 31, 2024

Choose a reason for hiding this comment

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

Indeed, it is actually not displayed anywhere and must have been forgotten in a previous PR when the information was placed in intro.rst.

Edit: It was linked in the menu, but redundant. So I removed it also from the menu.

@jlaehne
Copy link
Member Author

jlaehne commented Mar 31, 2024

failing tests are a version conflict of setuptools and setuptools_scm and unrelated to this PR.

@ericpre ericpre merged commit cf38d15 into main Mar 31, 2024
30 checks passed
@jlaehne jlaehne deleted the jlaehne-patch-1 branch March 31, 2024 14:32
@ericpre ericpre added this to the v0.2 milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants