MRG: refactoring doc build #429
Merged
Conversation
This file contains hidden or 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
acba5d2 to
df9652e
Compare
Codecov Report
@@ Coverage Diff @@
## master #429 +/- ##
=======================================
Coverage 83.26% 83.26%
=======================================
Files 301 301
Lines 28182 28182
Branches 3279 3279
=======================================
Hits 23467 23467
Misses 3712 3712
Partials 1003 1003
Continue to review full report at Codecov.
|
7890220 to
8cca160
Compare
* Remove our own copies of numpydoc and IPython console highlighting; * update conf.py to latest Sphinx; * refactor search for nipy and version getting; * add doc and dev requirements files.
Heaviside(0.0) doesn't resolve to a number (it's undefined); substitute it for 1, to allow matplotlib to use the result for the plots.
Missing terminators for math_dollar and default markup.
Build the docs to check for errors.
Need to install graphviz for docs.
Update gitwash from upstream.
Also - try to reduce number of complaints during API build.
Add some docs to hidden toctree to silence warnings.
Doc build already checks for presence of compiled nipy.
Make sections names standard, fix some parameter docs.
Makefile was using PYTHONPATH to pick up nipy source; we can use in-place build for that use - just pick up the installed nipy. Also - check in-place build.
Numpy is more aggressive about insisting on integers for arguments like sizes of arrays (as here).
Attempt to fix some build warnings by clearing up the docstrings; not much success.
Add tex distribution for pdf doc build.
Specify utf8 codec for tex file processing.
pdf doc build needs LaTeX packages.
32c9292 to
b3fbda9
Compare
Installation instructions were horribly out of date.
4445bd8 to
3f058e4
Compare
|
Any comments here? Especially, for the new installation instructions? |
|
Will merge tomorrow unless I hear otherwise. |
71b694a to
4fa797f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Remove vendored sphinx extensions, fix up code and markup for documentation
build.