diff --git a/docs/docs/contributing/documentation.rst b/docs/docs/contributing/documentation.rst index 78596ead2..4bd164201 100644 --- 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 `_ + +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.