Merge pull request #545 from cuthbertLab/v6a1-release

Preparing for V6a1 release
cuthbertLab · May 29, 2020 · 72382d4 · 72382d4
2 parents 850a91a + e560c28
commit 72382d4
Show file tree

Hide file tree

Showing 48 changed files with 1,807 additions and 1,736 deletions.
diff --git a/dist/dist.py b/dist/dist.py
@@ -39,21 +39,21 @@
 10. run documentation/upload.py or upload via ssh.
    -- you will need an MIT username and password
 
-11. zip up documentation/build/html and get ready to upload/delete it.
+11. zip up documentation/build/html and get ready to upload/delete it. (skip for Alpha/Beta)
 
 12. And finally this file. (from the command line; not as python -m...)
 
 13. COMMIT to Github at this point w/ commit comment of the new version,
     then don't change anything until the next step is done.
     (.gitignore will avoid uploading the large files created here...)
 
-14. Create a new release on GitHub and upload the TWO files created here. Use tag v5.0.1 (etc.).
+14. Create a new release on GitHub and upload the TWO files created here. Use tag v6.0.1 (etc.).
     Don't forget the "v" in the release tag.
     Drag in this order: .tar.gz, no-corpus.tar.gz
 
     Finish this before doing the next step, even though it looks like it could be done in parallel.
 
-15. Upload the new file to PyPI with "twine upload music21-5.0.5a2.tar.gz" [*]
+15. Upload the new file to PyPI with "twine upload music21-6.0.5a2.tar.gz" [*]
 
     [*] Requires twine to be installed
 

diff --git a/documentation/docbuild_requirements.txt b/documentation/docbuild_requirements.txt
@@ -1,2 +1,5 @@
+docutils
+pytest
+nbval
 ipython[notebook]>=6.0.0
 sphinx>=1.6
diff --git a/documentation/nbvalNotebook.py b/documentation/nbvalNotebook.py
@@ -7,9 +7,12 @@
 @author: cuthbert
 '''
 import sys
-import pytest # @UnusedImport  # pylint: disable=unused-import
-import nbval # @UnusedImport  # pylint: disable=unused-import
+# noinspection PyPackageRequirements
+import pytest  # @UnusedImport  # pylint: disable=unused-import
+# noinspection PyPackageRequirements
+import nbval  # @UnusedImport  # pylint: disable=unused-import
 import os
+import subprocess
 
 from music21 import environment
 from music21 import common
@@ -47,11 +50,21 @@ def runOne(nbFile):
     us = environment.UserSettings()
     museScore = us['musescoreDirectPNGPath']
     us['musescoreDirectPNGPath'] = '/skip' + str(museScore)
+
+    # this config file changes 0x39f3a0 to 0xADDRESS.
+    sanitize_fn = str(common.getRootFilePath()
+                      / 'documentation'
+                      / 'docbuild'
+                      / 'nbval-sanitize.cfg'
+                      )
     try:
-        retVal = os.system('pytest --nbval ' + str(nbFile) + ' --sanitize-with '
-                  + str(common.getRootFilePath()
-                            / 'documentation' / 'docbuild' / 'nbval-sanitize.cfg ')
-                  + '-q')
+        retVal = subprocess.run(
+            ['pytest',
+             '--disable-pytest-warnings',
+             '--nbval',  str(nbFile),
+             '--sanitize-with', sanitize_fn,
+             '-q']
+        )
     except (Exception, KeyboardInterrupt):
         raise
 

diff --git a/documentation/source/about/about.rst b/documentation/source/about/about.rst
@@ -174,15 +174,14 @@ Licensing and Copyright
 The `music21` Toolkit
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Music21 is Copyright (c) 2006-2017, Michael Scott Cuthbert and cuthbertLab.
+Music21 is Copyright © 2006-2020, Michael Scott Cuthbert and cuthbertLab.
 Music21 code (excluding content encoded in the corpus) is
-free and open-source software, licensed under the
-BSD License.
+free and open-source software, licensed under the BSD License.
 
 The `music21` Corpus
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The BSD `music21` software is distributed with a corpus of encoded
+The BSD-licensed `music21` software is distributed with a corpus of encoded
 compositions which are distributed
 with the permission of the encoders (and, where needed, the composers
 or arrangers) and where permitted

diff --git a/documentation/source/about/what.ipynb b/documentation/source/about/what.ipynb
diff --git a/documentation/source/conf.py b/documentation/source/conf.py
@@ -60,7 +60,8 @@
     # The full version, including alpha/beta/rc tags.
     release = music21.VERSION_STR
 except ImportError:
-    pass
+    version = 'unknown version'
+    release = 'unknown release'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -172,7 +173,8 @@
 html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
+# MSC -- changing this, since it's not clear that the DOCS are created using Sphinx
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 # html_show_copyright = True

diff --git a/documentation/source/developerReference/devTest_inversions.ipynb b/documentation/source/developerReference/devTest_inversions.ipynb