spacetelescope / cubeviz

Data analysis package for cubes. https://cubeviz.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

15 stars 25 forks source link

updated documentation #566

Closed hcferguson closed 5 years ago

hcferguson commented 5 years ago

Documentation updates.

@dravella -- I don't think inter sphinx is working.

hcferguson commented 5 years ago

@drdavella I don't think the inter sphinx links are working.

drdavella commented 5 years ago

@hcferguson okay I'll take a look.

drdavella commented 5 years ago

If I understand correctly, I think that intersphinx is intended more for linking to specific API documentation in other packages. So, for example, if we wanted to put a reference to the documentation of a class or function from specviz or glue, intersphinx would make that fairly simple.

It looks like the main intent here is just to link to the top-level documentation of those packages, in which case I would suggest just including the links inline in the documentation itself (see the top of docs/index.rst for examples).

drdavella commented 5 years ago

Also worth mentioning that the docbuild failure on travis looks meaningful:

Warning, treated as error:
/home/travis/build/spacetelescope/cubeviz/docs/analysis.rst:document isn't included in any toctree

hcferguson commented 5 years ago

I'll push up a couple fixes...

I think I link to the main doc page in in all but one case. I tried to link to a spectral-cube subsection on moments somewhere.

codecov[bot] commented 5 years ago

Codecov Report

Merging #566 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #566   +/-   ##
=======================================
  Coverage   68.23%   68.23%           
=======================================
  Files          26       26           
  Lines        4269     4269           
=======================================
  Hits         2913     2913           
  Misses       1356     1356

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 c21014a...48e036b. Read the comment docs.