Thanks to visit codestin.com
Credit goes to github.com

Skip to content

updating developer docs #8544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 28, 2017
Merged

updating developer docs #8544

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
83129fa
updating developer docs
choldgraf Apr 27, 2017
0baccc7
addressing comments
choldgraf Apr 28, 2017
530c62d
Update documenting_mpl.rst
choldgraf Apr 28, 2017
23f4757
Update documenting_mpl.rst
choldgraf Apr 28, 2017
5efe61c
Update documenting_mpl.rst
choldgraf Apr 28, 2017
ff1b20e
Update documenting_mpl.rst
choldgraf Apr 28, 2017
c6866a0
Update documenting_mpl.rst
choldgraf Apr 28, 2017
d73ff15
fixing link
choldgraf Apr 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update documenting_mpl.rst
  • Loading branch information
@choldgraf
choldgraf authored Apr 28, 2017
commit c6866a0db83d8c1fa116320cb85dffd27c716da6
15 changes: 8 additions & 7 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ General structure

All documentation is built from the :file:`doc/` directory. This directory contains both
``.rst`` files that contain pages in the documentation, directories that contain more
``.rst`` files, and configuration files for Sphinx.
``.rst`` files, and configuration files for Sphinx_.

.. note::

An exception to this are the directories :file:`gallery` and :file:`tutorials`, which
exist in the root directory. These contain Python files that are built by ``sphinx-gallery``.
exist in the root directory. These contain Python files that are built by `Sphinx Gallery <sphinx_gallery>`_.
When the docs are built, directories of the same name will be generated inside of :file:`docs/`.
The generated directories :file:`docs/gallery` and :file:`docs/tutorials` can be safely deleted.

Expand Down Expand Up @@ -302,11 +302,6 @@ working with Sphinx in general. Here are a few additional things to keep in mind
* The autodoc extension will handle index entries for the API, but additional
entries in the index_ need to be explicitly added.

.. _Sphinx: http://www.sphinx-doc.org
.. _documentation: http://www.sphinx-doc.org/contents.html
.. _`inline markup`: http://www.sphinx-doc.org/markup/inline.html
.. _index: http://www.sphinx-doc.org/markup/para.html#index-generating-markup

* Please limit the text width of docstrings to 70 characters.

* Keyword arguments should be described using a definition list.
Expand Down Expand Up @@ -542,3 +537,9 @@ Some helpful functions::
Shift region to the right

.. TODO: Add section about uploading docs

.. _Sphinx: http://www.sphinx-doc.org
.. _documentation: http://www.sphinx-doc.org/contents.html
.. _`inline markup`: http://www.sphinx-doc.org/markup/inline.html
.. _index: http://www.sphinx-doc.org/markup/para.html#index-generating-markup
.. _sphinx_gallery: https://sphinx-gallery.readthedocs.io/en/latest/