@@ -35,12 +35,12 @@ General structure
3535
3636All documentation is built from the :file: `doc/ ` directory. This directory contains both
3737``.rst `` files that contain pages in the documentation, directories that contain more
38- ``.rst `` files, and configuration files for Sphinx .
38+ ``.rst `` files, and configuration files for Sphinx _ .
3939
4040.. note ::
4141
4242 An exception to this are the directories :file: `gallery ` and :file: `tutorials `, which
43- exist in the root directory. These contain Python files that are built by `` sphinx-gallery `` .
43+ exist in the root directory. These contain Python files that are built by `Sphinx Gallery < sphinx_gallery >`_ .
4444 When the docs are built, directories of the same name will be generated inside of :file: `docs/ `.
4545 The generated directories :file: `docs/gallery ` and :file: `docs/tutorials ` can be safely deleted.
4646
@@ -302,11 +302,6 @@ working with Sphinx in general. Here are a few additional things to keep in mind
302302* The autodoc extension will handle index entries for the API, but additional
303303 entries in the index _ need to be explicitly added.
304304
305- .. _Sphinx : http://www.sphinx-doc.org
306- .. _documentation : http://www.sphinx-doc.org/contents.html
307- .. _`inline markup` : http://www.sphinx-doc.org/markup/inline.html
308- .. _index : http://www.sphinx-doc.org/markup/para.html#index-generating-markup
309-
310305* Please limit the text width of docstrings to 70 characters.
311306
312307* Keyword arguments should be described using a definition list.
@@ -542,3 +537,9 @@ Some helpful functions::
542537 Shift region to the right
543538
544539.. TODO: Add section about uploading docs
540+
541+ .. _Sphinx : http://www.sphinx-doc.org
542+ .. _documentation : http://www.sphinx-doc.org/contents.html
543+ .. _`inline markup` : http://www.sphinx-doc.org/markup/inline.html
544+ .. _index : http://www.sphinx-doc.org/markup/para.html#index-generating-markup
545+ .. _sphinx_gallery : https://sphinx-gallery.readthedocs.io/en/latest/
0 commit comments