docs: contrib/docs: Add cross-ref help

isso-comments · Apr 30, 2022 · f53ee04 · f53ee04
1 parent 3c0060d
commit f53ee04
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/docs/contributing/documentation.rst b/docs/docs/contributing/documentation.rst
@@ -3,3 +3,19 @@ Writing Documentation
 
 - Sphinx
 - How to write good docs
+
+Help
+----
+
+Helpful links:
+
+- `Cross-referencing with Sphinx <https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html>`_
+
+Debugging cross-references:
+
+.. code-block:: sh
+
+    python -m sphinx.ext.intersphinx docs/_build/html/objects.inv
+
+Also make sure you have used ``:ref:`` or ``:doc``
+correctly and not confused the two.