LumiSpy / lumispy

Luminescence data analysis with HyperSpy.
https://lumispy.org
GNU General Public License v3.0
26 stars 18 forks source link

Small improvements to docs #181

Closed hakonanes closed 1 year ago

hakonanes commented 1 year ago

Description of the change

Fixed a link to kikuchipy's contributing guide in the LumiSpy contributing guide by making it "dynamic" with Intersphinx. Also fixed the Sphinx version in setup.py so installing in editable mode with pip install -e . from root works.

Progress of the PR

hakonanes commented 1 year ago

For completeness, this was the initial error I got when trying to install a development version of LumiSpy in editable mode:

> pip install -e .
Obtaining file:///home/hakon/kode/lumispy
  Preparing metadata (setup.py) ... error
  error: subprocess-exited-with-error

  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [3 lines of output]
      /home/hakon/miniconda3/envs/ls-dev/lib/python3.10/site-packages/setuptools/config/setupcfg.py:520: SetuptoolsDeprecationWarning: The license_file parameter is deprecated, use license_files instead.
        warnings.warn(msg, warning_class)
      error in lumispy setup command: 'extras_require' must be a dictionary whose values are strings or lists of strings containing valid project/version requirement specifiers.
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: metadata-generation-failed

× Encountered error while generating package metadata.
╰─> See above for output.

note: This is an issue with the package mentioned above, not pip.
hint: See above for details.

Both the warning (license_file -> license_files) and the error (remove extra ">=") are fixed in this PR.

codecov-commenter commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (b402c96) 100.00% compared to head (8bf558b) 100.00%.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #181 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 12 12 Lines 545 545 ========================================= Hits 545 545 ``` Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LumiSpy). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LumiSpy)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.