Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
What's new
7
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
Tiago Peixoto
graph-tool
Commits
831eb93f
Commit
831eb93f
authored
May 08, 2012
by
Tiago Peixoto
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add missing sphinxext files
parent
874d6fee
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
78 additions
and
0 deletions
+78
-0
doc/sphinxext/MANIFEST.in
doc/sphinxext/MANIFEST.in
+2
-0
doc/sphinxext/README.txt
doc/sphinxext/README.txt
+45
-0
doc/sphinxext/setup.py
doc/sphinxext/setup.py
+31
-0
No files found.
doc/sphinxext/MANIFEST.in
0 → 100644
View file @
831eb93f
recursive-include tests *.py
include *.txt
doc/sphinxext/README.txt
0 → 100644
View file @
831eb93f
=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================
Numpy's documentation uses several custom extensions to Sphinx. These
are shipped in this ``numpydoc`` package, in case you want to make use
of them in third-party projects.
The following extensions are available:
- ``numpydoc``: support for the Numpy docstring format in Sphinx, and add
the code description directives ``np:function``, ``np-c:function``, etc.
that support the Numpy docstring syntax.
- ``numpydoc.traitsdoc``: For gathering documentation about Traits attributes.
- ``numpydoc.plot_directive``: Adaptation of Matplotlib's ``plot::``
directive. Note that this implementation may still undergo severe
changes or eventually be deprecated.
numpydoc
========
Numpydoc inserts a hook into Sphinx's autodoc that converts docstrings
following the Numpy/Scipy format to a form palatable to Sphinx.
Options
-------
The following options can be set in conf.py:
- numpydoc_use_plots: bool
Whether to produce ``plot::`` directives for Examples sections that
contain ``import matplotlib``.
- numpydoc_show_class_members: bool
Whether to show all members of a class in the Methods and Attributes
sections automatically.
- numpydoc_edit_link: bool (DEPRECATED -- edit your HTML template instead)
Whether to insert an edit link after docstrings.
doc/sphinxext/setup.py
0 → 100644
View file @
831eb93f
from
distutils.core
import
setup
import
setuptools
import
sys
,
os
version
=
"0.4"
setup
(
name
=
"numpydoc"
,
packages
=
[
"numpydoc"
],
package_dir
=
{
"numpydoc"
:
""
},
version
=
version
,
description
=
"Sphinx extension to support docstrings in Numpy format"
,
# classifiers from http://pypi.python.org/pypi?%3Aaction=list_classifiers
classifiers
=
[
"Development Status :: 3 - Alpha"
,
"Environment :: Plugins"
,
"License :: OSI Approved :: BSD License"
,
"Topic :: Documentation"
],
keywords
=
"sphinx numpy"
,
author
=
"Pauli Virtanen and others"
,
author_email
=
"pav@iki.fi"
,
url
=
"http://github.com/numpy/numpy/tree/master/doc/sphinxext"
,
license
=
"BSD"
,
zip_safe
=
False
,
install_requires
=
[
"Sphinx >= 1.0.1"
],
package_data
=
{
'numpydoc'
:
'tests'
,
''
:
''
},
entry_points
=
{
"console_scripts"
:
[
"autosummary_generate = numpydoc.autosummary_generate:main"
,
],
},
)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment