Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

use canonical filename of RTD configuration and enable nitpicky mode #337

Merged
merged 5 commits into from
Sep 20, 2022

Conversation

zacharyburnett
Copy link
Contributor

Description

update the name of the ReadTheDocs configuration file from .readthedocs.yml to .readthedocs.yaml and enable nitpicky to validate intra-doc links

@codecov
Copy link

codecov bot commented Sep 20, 2022

Codecov Report

Base: 94.46% // Head: 94.46% // No change to project coverage 👍

Coverage data is based on head (665a27f) compared to base (3a80de6).
Patch has no changes to coverable lines.

❗ Current head 665a27f differs from pull request most recent head fd03b3b. Consider uploading reports for the commit fd03b3b to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #337   +/-   ##
=======================================
  Coverage   94.46%   94.46%           
=======================================
  Files          17       17           
  Lines        2096     2096           
=======================================
  Hits         1980     1980           
  Misses        116      116           
Impacted Files Coverage Δ
synphot/observation.py 99.06% <ø> (ø)
synphot/specio.py 99.09% <ø> (ø)
synphot/spectrum.py 99.33% <ø> (ø)
synphot/units.py 91.72% <ø> (ø)
synphot/utils.py 98.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

@zacharyburnett
Copy link
Contributor Author

zacharyburnett commented Sep 20, 2022

the RTD build ran into a few errors / warnings: https://readthedocs.org/projects/synphot/builds/18123748/

/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/models.py:docstring of synphot.models.Gaussian1D:1: WARNING: py:class reference target not found: synphot.models.BaseGaussian1D
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/models.py:docstring of synphot.models.GaussianAbsorption1D:1: WARNING: py:class reference target not found: synphot.models.BaseGaussian1D
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/observation.py:docstring of synphot.observation.Observation.effstim:12: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/observation.py:docstring of synphot.observation.Observation.plot:20: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/observation.py:docstring of synphot.observation.Observation.sample_binned:15: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/specio.py:docstring of synphot.specio.read_ascii_spec:19: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/specio.py:docstring of synphot.specio.read_ascii_spec:22: WARNING: py:func reference target not found: astropy.io.ascii.ui.read
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/specio.py:docstring of synphot.specio.read_fits_spec:23: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/specio.py:docstring of synphot.specio.write_fits_spec:53: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.BaseSourceSpectrum.__call__:13: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.BaseSpectrum:12: WARNING: py:obj reference target not found: astropy.modeling.models
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.BaseSpectrum.integrate:38: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.BaseSpectrum.to_spectrum1d:16: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.SourceSpectrum.plot:15: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.SourceSpectrum.to_fits:17: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.SpectralElement.check_overlap:35: WARNING: py:obj reference target not found: waveset
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/spectrum.py:docstring of synphot.spectrum.SpectralElement.equivwidth:8: WARNING: py:meth reference target not found: integrate
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/units.py:docstring of synphot.units.convert_flux:15: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/units.py:docstring of synphot.units.validate_quantity:15: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/units.py:docstring of synphot.units.validate_unit:14: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/units.py:docstring of synphot.units.validate_unit:22: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/envs/337/lib/python3.9/site-packages/synphot/utils.py:docstring of synphot.utils.generate_wavelengths:27: WARNING: py:obj reference target not found: astropy.units.core.Unit
/home/docs/checkouts/readthedocs.org/user_builds/synphot/checkouts/337/docs/<rst_epilog>:3: WARNING: py:class reference target not found: synphot.models.BaseGaussian1D

@pllim
Copy link
Contributor

pllim commented Sep 20, 2022

I would approve if you also fix the 23 warnings. Thanks! 😉

@pllim
Copy link
Contributor

pllim commented Sep 20, 2022

One does not simply turn on nitpicky.

synphot/spectrum.py Outdated Show resolved Hide resolved
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Thanks!

@pllim pllim merged commit cb3ff4b into spacetelescope:master Sep 20, 2022
@zacharyburnett zacharyburnett deleted the rtd_update branch September 21, 2022 01:39
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants