META: Add note on docstring source locations

caporaso-lab · Jul 2, 2024 · 61fb69b · 61fb69b
1 parent 3f69339
commit 61fb69b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/book/docs/developer-documentation.md b/book/docs/developer-documentation.md
@@ -7,3 +7,9 @@ Contributions from others are welcomed and acknowledged via the project's [GitHu
 At the moment, while we're still laying the groundwork, we're accepting only [specific contributions](https://github.com/caporaso-lab/developing-with-qiime2/labels/help%20wanted).
 
 If you have suggestions or feedback [we'd love to hear from you](https://github.com/caporaso-lab/developing-with-qiime2/issues).
+
+
+## Finding docstring sources
+
+For API documentation, the source of documentation for code entities will be defined by their respective docstrings.
+In many cases, the linkcode extension will provide a link (via ``[source]``) to the source code of these entities. However in certain cases, (such as plugin types), autodoc can only find docstrings at the provided module path (and linkcode is unable to resolve a source). This means that these docstrings will be found in ``qiime2/plugin/__init__.py`` (or wherever the module provided to autodoc indicates).