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.
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
MAINT: setup.py cleanups and additions #454
Merged
Merged
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
f19c889
BLD: fix the setup.py build_sphinx command
pv 986f51d
DOC: document the build_sphinx command
pv d94fcce
MAINT: setup.py: point test suite to nose, so that 'setup.py test' works
pv 3d06e4a
MAINT: remove setup*egg*.py -- always use setuptools, if present
pv 83d01e6
MAINT: add all source files to MANIFEST.in
pv 8c67a67
BUG: setup.py: pass non-prefixed scipy path to cythonize, but set cwd
pv b6dad11
MAINT: include everything in MANIFEST.in
pv a5b1514
MAINT: add more to ignore in MANIFEST.in
pv db44eee
DOC: update doc/README.txt
pv 45b0e71
MAINT: setup.py: disable Cython regeneration for released versions
pv File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,20 @@ | ||
# Use .add_data_files and .add_data_dir methods in a appropriate | ||
# setup.py files to include non-python files such as documentation, | ||
# data, etc files to distribution. Avoid using MANIFEST.in for that. | ||
# | ||
include MANIFEST.in | ||
include *.txt | ||
include setupscons.py | ||
include setupegg.py | ||
include setup.py | ||
include scipy/*.py | ||
# Cython generation | ||
include cythonize.dat | ||
include tools/cythonize.py | ||
include scipy/cluster/_vq_rewrite.c # unused, but ship still | ||
# Add Cython files | ||
recursive-include scipy *.pyx *.pyx.in *.pxd *.pxi | ||
# Add swig files | ||
recursive-include scipy *.i | ||
# Adding scons build related files not found by distutils | ||
recursive-include scipy SConstruct SConscript | ||
recursive-include scipy README | ||
# Add files to allow Bento build | ||
include f2py.py | ||
include interface_gen.py | ||
include bscript bento.info | ||
recursive-include scipy bscript bento.info | ||
# Top-level build scripts | ||
include setup.py setupscons.py bscript bento.info | ||
# All source files | ||
recursive-include scipy * | ||
# All documentation | ||
recursive-include doc * | ||
# Add build and testing tools | ||
include tools/py3tool.py | ||
include tox.ini | ||
include tools/test-installed-scipy.py | ||
# Add documentation: we don't use add_data_dir since we do not want to include | ||
# this at installation, only for sdist-generated tarballs | ||
include doc/Makefile doc/postprocess.py | ||
recursive-include doc/release * | ||
recursive-include doc/source * | ||
recursive-include doc/sphinxext * | ||
recursive-include tools * | ||
# Cached Cython signatures | ||
include cythonize.dat | ||
# Exclude what we don't want to include | ||
prune scipy/special/tests/data/boost | ||
include scipy/special/Faddeeva.hh | ||
prune scipy/special/tests/data/gsl | ||
prune doc/build | ||
prune doc/source/generated | ||
prune */__pycache__ | ||
global-exclude *.pyc *~ *.bak | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,21 @@ | ||
SciPy Reference Guide | ||
===================== | ||
SciPy Documentation | ||
=================== | ||
|
||
Instructions | ||
------------ | ||
How to build it | ||
--------------- | ||
The easy way to build the documentation is to run | ||
|
||
python setup.py build_sphinx | ||
|
||
This will make first build Scipy in-place, and then generate documentation for | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo, remove "make" |
||
it. | ||
|
||
Another way | ||
----------- | ||
1. Optionally download an XML dump of the newest docstrings from the doc wiki | ||
at ``/pydocweb/dump`` and save it as ``dump.xml``. | ||
2. Run ``make html`` or ``make dist`` | ||
|
||
You can also run ``summarize.py`` to see which parts of the Numpy | ||
namespace are documented. | ||
Note that ``make html`` builds the documentation for the currently installed | ||
version of Scipy, not the one corresponding to the source code here. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I propose to add
*.swp
(Vim tempfiles) and*.pyo
here