mirrors/xonsh
1
0
Fork 0
mirror of https://github.com/xonsh/xonsh.git synced 2025-03-06 17:30:59 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' into whichwhich

Browse source
This commit is contained in:
Anthony Scopatz 2016-05-17 11:47:06 -04:00
commit 086078b098
5 changed files with 16 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.gitattributes vendored
View file

@ -1,4 +1,4 @@
tests/histories/*.json text eol=lf
# Set the default behavior, in case people don't have core.autocrlf set. # Set the default behavior, in case people don't have core.autocrlf set.
* text=auto * text=auto
tests/histories/*.json text eol=lf

1
docs/api/index.rst
View file

@ -69,3 +69,4 @@ For those of you who want the gritty details.
:maxdepth: 1 :maxdepth: 1
mplhooks mplhooks

7
docs/devguide.rst
View file

@ -51,7 +51,7 @@ is open to interpretation.
``"""triple double quotes"""`` for docstrings. Double quotes are allowed to ``"""triple double quotes"""`` for docstrings. Double quotes are allowed to
prevent single quote escaping, e.g. ``"Y'all c'mon o'er here!"`` prevent single quote escaping, e.g. ``"Y'all c'mon o'er here!"``
* We use sphinx with the numpydoc extension to autogenerate API documentation. Follow * We use sphinx with the numpydoc extension to autogenerate API documentation. Follow
the numpydoc standard for docstrings `described here <https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_. the `numpydoc`_ standard for docstrings.
* Simple functions should have simple docstrings. * Simple functions should have simple docstrings.
* Lines should be at most 80 characters long. The 72 and 79 character * Lines should be at most 80 characters long. The 72 and 79 character
recommendations from PEP8 are not required here. recommendations from PEP8 are not required here.
@ -148,7 +148,7 @@ Docstrings
No matter what language you are writing in, you should always have No matter what language you are writing in, you should always have
documentation strings along with you code. This is so important that it is documentation strings along with you code. This is so important that it is
part of the style guide. When writing in Python, your docstrings should be part of the style guide. When writing in Python, your docstrings should be
in reStructured Text using the numpydoc format. in reStructured Text using the `numpydoc`_ format.
------------------------ ------------------------
Auto-Documentation Hooks Auto-Documentation Hooks
@ -346,4 +346,5 @@ Document History
Portions of this page have been forked from the PyNE documentation, Portions of this page have been forked from the PyNE documentation,
Copyright 2011-2015, the PyNE Development Team. All rights reserved. Copyright 2011-2015, the PyNE Development Team. All rights reserved.
.. _PEP8: http://www.python.org/dev/peps/pep-0008/ .. _PEP8: https://www.python.org/dev/peps/pep-0008/
.. _numpydoc: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

3
requirements-docs.txt Normal file
View file

@ -0,0 +1,3 @@
cloud_sptheme
numpydoc==0.5
Sphinx