@@ -35,12 +35,12 @@ General structure
35
35
36
36
All documentation is built from the :file: `doc/ ` directory. This directory contains both
37
37
``.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 _ .
39
39
40
40
.. note ::
41
41
42
42
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 >`_ .
44
44
When the docs are built, directories of the same name will be generated inside of :file: `docs/ `.
45
45
The generated directories :file: `docs/gallery ` and :file: `docs/tutorials ` can be safely deleted.
46
46
@@ -302,11 +302,6 @@ working with Sphinx in general. Here are a few additional things to keep in mind
302
302
* The autodoc extension will handle index entries for the API, but additional
303
303
entries in the index _ need to be explicitly added.
304
304
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
-
310
305
* Please limit the text width of docstrings to 70 characters.
311
306
312
307
* Keyword arguments should be described using a definition list.
@@ -542,3 +537,9 @@ Some helpful functions::
542
537
Shift region to the right
543
538
544
539
.. 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