Google docstrings#19
Merged
Merged
Conversation
Add autodoc_mock_imports for PyWCSTools._wcs and PyWCSTools.wcs so that Sphinx can import astWCS, astImages, and astPlots without requiring the compiled C extension. Also fix an over-indented RST bullet list in the addPlotObjects docstring that caused a docutils unexpected-indentation error. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace plain function/class name mentions in docstrings with :func:, :meth:, :class:, and :data: roles so Sphinx generates hyperlinks in the HTML output. Covers cross-module references (e.g. astImages functions cited in astPlots) and intra-module references (e.g. fitSEDDict <-> mags2SEDDict <-> makeModelSEDDictList in astSED). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replace plain module names in the README bullet list with :mod: roles so the Sphinx-rendered index page links directly to each module's API reference section. Also adds the missing astStats section to reference.rst. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Replaces bare URLs in parentheses with RST named links so the URL is hidden in rendered output (docs, GitHub). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.