Skip to content

Commit 3ad399f

Browse files
authored
Merge pull request #1783 from cuthbertLab/v9.7-b
Update dist.py documentation
2 parents d82ac2a + c2483fb commit 3ad399f

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

dist/dist.py

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
This takes a while and runs single core, and then almost always needs code patches
2727
so allocate time (2 min on M4). Start working on the announcement while it's running.
2828
29+
2930
4. run test/warningMultiprocessTest.py for lowest and highest Py version -- fix all warnings!
3031
5. run `from music21.test import treeYield
3132
and then run `treeYield.find_all_non_hashable_m21objects()` and check that the set returned is
@@ -38,15 +39,22 @@
3839
7. run documentation/make.py clean (skip on minor version changes) -- you may need to make a
3940
documentation/build directory first.
4041
8. run documentation/make.py linkcheck [*] - missing http://www.musicxml.org/dtds/partwise.dtd
41-
and code-of-conduct links are both okay.
42+
and code-of-conduct links are both okay. The points about
43+
"more than one target found for cross-reference 'Direction'"
44+
are known bugs in Sphinx (when the same named Enum appears in different modules)
45+
and we can't fix.
46+
StackOverflow seems also to be presenting linkcheck -- check manually every once in
47+
a while, but looking good May 2025.
48+
Ignore the errors at the end if everything looks good.
4249
9. run documentation/make.py [*]
4350
4451
[*] you will need sphinx, Jupyter (pip or easy_install), markdown, and pandoc (.dmg) installed
4552
4653
10. move music21 documentation/build/html to music21.org/music21docs/
4754
via Amazon S3 (contact MSAC for authentication if need be)
4855
49-
11. zip up documentation/build/html and get ready to upload/delete it.
56+
11. zip up documentation/build/html and get ready to upload/delete it (you can put on your
57+
desktop or wherever you like).
5058
Rename to music21.v.9.5.0-docs.zip (skip for Alpha/Beta)
5159
5260
12. From the music21 main folder (not subfolder) run "hatch build" --
@@ -56,7 +64,7 @@
5664
This builds the dist/music21-9.3.0.tar.gz and dist/music21-9.3.0-py3-none-any.whl
5765
files. That used to be what *this* script did, but now hatch does it better!
5866
59-
13. Run this file: it builds the no-corpus version of music21. (need Python 3.12 or higher)
67+
13. Run this (dist.py) file: it builds the no-corpus version of music21. (need Python 3.12 or higher)
6068
DO NOT RUN THIS ON A PC or the Mac .tar.gz might have an incorrect permission if you do.
6169
6270
14. PR and Commit to GitHub at this point w/ commit comment of the new version,

0 commit comments

Comments
 (0)