mkg33

General documentation style remarks for internal use:

Ideally, a non-expert should review the given documentation file and check that the examples can be run and that no additional information is necessary to understand the documentation.

provide a high-level introduction about the package and what it can do

if applicable, list any requirements (skills, software, hardware, time required, etc.)

always provide a minimal example that is self-contained and easy to understand

mkg33

 Mes-iMac:scipy me$ python3 runtests.py
Building, see build.log...
Build OK (0:00:05.027994 elapsed)
/Users/me/Downloads/scipy/build/testenv/lib/python3.7/site-packages/scipy/__init__.py:144: UserWarning: NumPy 1.14.5 or above is required for this version of SciPy (detected version 1.11.3)
  UserWarning)
=============================================================================================== test session starts ================================================================================================
platform darwin -- Python 3.7.4, pytest-5.3.2, py-1.8.1, pluggy-0.13.1
rootdir: /Users/me/Downloads/scipy, inifile: pytest.ini
collected 6223 items / 120 errors / 192 deselected / 5911 selected                                                                                                                                                 

mkg33

scipy me$ python3 runtests.py
Building, see build.log...
Build OK (0:00:05.020591 elapsed)
===================================== test session starts =====================================
platform darwin -- Python 3.7.5, pytest-5.3.1, py-1.8.0, pluggy-0.13.1
rootdir: /Users/me/Downloads/scipy, inifile: pytest.ini
collected 31997 items / 10954 deselected / 21043 selected                                     

scipy/_build_utils/tests/test_circular_imports.py .                                     [  0%]
scipy/_build_utils/tests/test_scipy_version.py .                                        [  0%]

mkg33

Building, see build.log...
    ... build in progress (0:01:00.244486 elapsed)
    ... build in progress (0:02:00.476575 elapsed)
    ... build in progress (0:03:00.694415 elapsed)
    ... build in progress (0:04:00.905124 elapsed)
    ... build in progress (0:05:01.132399 elapsed)
    ... build in progress (0:06:01.353129 elapsed)
    ... build in progress (0:07:01.654848 elapsed)
Build OK (0:07:23.743923 elapsed)
mkdir -p build/html build/doctrees

mkg33

python3 runtests.py --doc
Building, see build.log...
    ... build in progress (0:01:00.244486 elapsed)
    ... build in progress (0:02:00.476575 elapsed)
    ... build in progress (0:03:00.694415 elapsed)
    ... build in progress (0:04:00.905124 elapsed)
    ... build in progress (0:05:01.132399 elapsed)
    ... build in progress (0:06:01.353129 elapsed)
    ... build in progress (0:07:01.654848 elapsed)
Build OK (0:07:23.743923 elapsed)

mkg33

Package                       Version           
----------------------------- ------------------
alabaster                     0.7.12            
altgraph                      0.16.1            
appnope                       0.1.0             
atlas                         0.27.0            
attrs                         19.3.0            
autodoc                       0.5.0             
Babel                         2.7.0             
backcall                      0.1.0             

mkg33

Mes-iMac:doc me$ make clean
rm -rf build/* source/generated
Mes-iMac:doc me$ make html
# for testing
# @echo installed scipy 2bea64c334 matches git version 2bea64c334; exit 1
mkdir -p build/html build/doctrees
LANG=C python3 -msphinx -b html -d build/doctrees   source build/html 
Running Sphinx v2.2.1
SciPy (VERSION 1.5.0.dev0+2bea64c)
[autosummary] generating autosummary for: api.rst, ccallback.rst, cluster.hierarchy.rst, cluster.rst, cluster.vq.rst, constants.rst, fft.rst, fftpack.rst, hacking.rst, index.rst, ..., sparse.linalg.rst, sparse.rst, spatial.distance.rst, spatial.rst, spatial.transform.rst, special.cython_special.rst, special.rst, stats.mstats.rst, stats.rst, toolchain.rst