ENH: Add memory to circle [skip travis] [skip github]

mne-tools · Oct 16, 2020 · e5c06f5 · e5c06f5
1 parent db510cc
commit e5c06f5
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 9 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -115,11 +115,11 @@ jobs:
               touch pattern.txt;
               if [ "$CIRCLE_BRANCH" == "master" ] || [[ $(cat gitlog.txt) == *"[circle full]"* ]]; then
                 echo "Doing a full dev build";
-                echo html_dev > build.txt;
+                echo html_dev-memory > build.txt;
                 python -c "import mne; mne.datasets._download_all_example_data()";
               elif [ "$CIRCLE_BRANCH" == "maint/0.21" ]; then
                 echo "Doing a full stable build";
-                echo html_stable > build.txt;
+                echo html_stable-memory > build.txt;
                 python -c "import mne; mne.datasets._download_all_example_data()";
               else
                 echo "Doing a partial build";
@@ -216,7 +216,7 @@ jobs:
                 echo PATTERN="$PATTERN";
                 if [[ $PATTERN ]]; then
                   PATTERN="\(${PATTERN::-2}\)";
-                  echo html_dev-pattern > build.txt;
+                  echo html_dev-pattern-memory > build.txt;
                 else
                   echo html_dev-noplot > build.txt;
                 fi;
@@ -234,7 +234,7 @@ jobs:
         - run:
             name: make test-doc
             command: |
-              if [[ $(cat gitlog.txt) == *"[circle front]"* ]] || [[ $(cat build.txt) == "html_dev" ]] || [[ $(cat build.txt) == "html_stable" ]]; then
+              if [[ $(cat gitlog.txt) == *"[circle front]"* ]] || [[ $(cat build.txt) == "html_dev-memory" ]] || [[ $(cat build.txt) == "html_stable-memory" ]]; then
                 make test-doc;
                 mkdir -p doc/_build/test-results/test-doc;
                 cp junit-results.xml doc/_build/test-results/test-doc/junit.xml;
@@ -245,6 +245,16 @@ jobs:
             command: |
               cd doc;
               PATTERN=$(cat ../pattern.txt) make $(cat ../build.txt);
+        - run:
+            name: Show profiling output
+            when: always
+            command: |
+              if compgen -G "doc/*.mprof" > /dev/null; then
+                mkdir -p doc/generated
+                mprof plot doc/*.mprof --output doc/generated/memory.png
+              else
+                echo "No profile data found in doc/"
+              fi
         - run:
             name: Sanity check system state
             command: |
@@ -254,7 +264,7 @@ jobs:
         - run:
             name: Reduce artifact upload time
             command: |
-              if grep -q html_dev-pattern build.txt || grep -q html_dev-noplot build.txt; then
+              if grep -q html_dev-pattern-memory build.txt || grep -q html_dev-noplot build.txt; then
                 tar czf doc/_build/html/_downloads.tgz doc/_build/html/_downloads
                 rm -Rf doc/_build/html/_downloads
                 rm -f doc/auto_*/*/*.pickle

diff --git a/doc/Makefile b/doc/Makefile
@@ -5,6 +5,7 @@
 SPHINXOPTS    = -nWT --keep-going
 SPHINXBUILD   = sphinx-build
 PAPER         =
+MPROF         = mprof run --python sphinx
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -36,6 +37,11 @@ clean:
 	-rm -rf _build auto_examples auto_tutorials generated *.stc *.fif *.nii.gz
 
 html_stable:
+	$(MPROF) -b html $(ALLSPHINXOPTS) _build/html_stable
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html_stable."
+
+html_stable-memory:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html_stable
 	@echo
 	@echo "Build finished. The HTML pages are in _build/html_stable."
@@ -45,8 +51,18 @@ html_dev:
 	@echo
 	@echo "Build finished. The HTML pages are in _build/html"
 
+html_dev-memory:
+	BUILD_DEV_HTML=1 $(MPROF) -b html $(ALLSPHINXOPTS) _build/html
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html"
+
 html_dev-pattern:
-	BUILD_DEV_HTML=1 $(SPHINXBUILD) -D plot_gallery=1 -D sphinx_gallery_conf.filename_pattern=$(PATTERN) -b html $(ALLSPHINXOPTS) _build/html
+	BUILD_DEV_HTML=1 $(SPHINXBUILD) -D sphinx_gallery_conf.filename_pattern=$(PATTERN) -D sphinx_gallery_conf.run_stale_examples=True -b html $(ALLSPHINXOPTS) _build/html
+	@echo
+	@echo "Build finished. The HTML pages are in _build/html"
+
+html_dev-pattern-memory:
+	BUILD_DEV_HTML=1 $(MPROF) -D sphinx_gallery_conf.filename_pattern=$(PATTERN) -D sphinx_gallery_conf.run_stale_examples=True -b html $(ALLSPHINXOPTS) _build/html
 	@echo
 	@echo "Build finished. The HTML pages are in _build/html"
 

diff --git a/examples/inverse/plot_mixed_source_space_inverse.py b/examples/inverse/plot_mixed_source_space_inverse.py
@@ -1,7 +1,7 @@
 """
-===================================================================
-Compute MNE inverse solution on evoked data in a mixed source space
-===================================================================
+=====================================================================
+Compute MNE inverse solution on evoked data with a mixed source space
+=====================================================================
 
 Create a mixed source space and compute an MNE inverse solution on an
 evoked dataset.