PAHFIT / pahfit

Model Decomposition for Near- to Mid-Infrared Spectroscopy of Astronomical Sources
https://pahfit.readthedocs.io/
18 stars 26 forks source link

Modification of the PAHFIT v2.1 docs #170

Closed ThomasSYLai closed 2 years ago

ThomasSYLai commented 2 years ago

This PR is a replacement for PR #138. The text has been edited following the comments. The figure of the fitted results of the 2.5-38 µm spectrum has also been added.

codecov-commenter commented 2 years ago

Codecov Report

Merging #170 (aecb59d) into master (3ea53e1) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #170   +/-   ##
=======================================
  Coverage   51.74%   51.74%           
=======================================
  Files           8        8           
  Lines         516      516           
=======================================
  Hits          267      267           
  Misses        249      249           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3ea53e1...aecb59d. Read the comment docs.

ThomasSYLai commented 2 years ago

@karllark, I didn't quite get where this warning --- "/home/runner/work/pahfit/pahfit/docs/PAHFIT_v2.1.rst:document isn't included in any toctree" is coming from. Can you point me to a correct way to fix this? Thanks!

karllark commented 2 years ago

@karllark, I didn't quite get where this warning --- "/home/runner/work/pahfit/pahfit/docs/PAHFIT_v2.1.rst:document isn't included in any toctree" is coming from. Can you point me to a correct way to fix this? Thanks!

You need to include a link to version_description.rst in index.rst so that users can find the description of the different versions. Just add it to the list of topics in "User Documentation."

ThomasSYLai commented 2 years ago

@karllark, I didn't quite get where this warning --- "/home/runner/work/pahfit/pahfit/docs/PAHFIT_v2.1.rst:document isn't included in any toctree" is coming from. Can you point me to a correct way to fix this? Thanks!

You need to include a link to version_description.rst in index.rst so that users can find the description of the different versions. Just add it to the list of topics in "User Documentation."

Thanks. I've added the links to index.rst.

karllark commented 2 years ago

Great. Will merge this when PR #116 is merged.