Skip to content

Commit d607768

Browse files
committed
DO NOT MERGE: drop some links to see if they're the bad ones.
1 parent a6e68d8 commit d607768

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

stack/documenting-code-with-type-annotations.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Documenting code with type hints
55
################################
66

77
Many DM packages (especially the middleware suite) use type hints for static analysis, which often duplicates the type information included in docstrings.
8-
Documentation built with `Documenteer 2.x`_ can often leave this information out, because the `sphinx-autodoc-typehints`_ extension (included automatically) will parse the annotations and include type information in the docs automatically.
8+
Documentation built with ``Documenteer 2.x`` can often leave this information out, because the ``sphinx-autodoc-typehints`` extension (included automatically) will parse the annotations and include type information in the docs automatically.
99

1010
.. note::
1111
`pipelines.lsst.io`_ is currently still built with Documenteer 1.x, but is expected to transition soon.
@@ -110,6 +110,4 @@ Annotations on properties and attributes are not applied to documentation automa
110110
Important instance attributes that cannot have a class-level default value should be made into properties so they can be documented.
111111

112112

113-
.. _`Documenteer 2.x`: https://documenteer.lsst.io
114-
.. _`sphinx-autodoc-typehints`: https://pypi.org/project/sphinx-autodoc-typehints/
115113
.. _`pipelines.lsst.io`: https://pipelines.lsst.io

0 commit comments

Comments
 (0)