[Django] #36162: Docs make black doesn't work on MacOS

[Django]

#36162: Docs make black doesn't work on MacOS
----------------------------------------+------------------------------
Reporter: Mike Edmunds | Owner: Mike Edmunds
Type: Bug | Status: assigned
Component: Packaging | Version: 5.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
----------------------------------------+------------------------------
The docs `make black` target doesn't work on MacOS (and presumably other
BSD) due to differences in the find command. This complicates checking
docs locally (or in general investigating issues with blacken-docs).

{{{#!shell
% (cd docs; make black)
find -name "*.txt" -not -path "./_build/*" -not -path "./_theme/*" \
| xargs blacken-docs --rst-literal-block; echo $? >
"_build/black/output.txt"
find: illegal option -- n
usage: find [-H | -L | -P] [-EXdsx] [-f path] path ... [expression]
find [-H | -L | -P] [-EXdsx] -f path [path ...] [expression]

% uname -a
Darwin --- 24.2.0 Darwin Kernel Version 24.2.0: Fri Dec 6 18:40:14 PST
2024; root:xnu-11215.61.5~2/RELEASE_ARM64_T8103 arm64
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36162>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36162: Docs make black doesn't work on MacOS

------------------------------+----------------------------------------

Reporter: Mike Edmunds | Owner: Mike Edmunds
Type: Bug | Status: assigned
Component: Packaging | Version: 5.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

------------------------------+----------------------------------------
Changes (by Mike Edmunds):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:1>

[Django]

#36162: Docs make black doesn't work on MacOS
------------------------------+----------------------------------------
Reporter: Mike Edmunds | Owner: Mike Edmunds
Type: Bug | Status: assigned

Component: Packaging | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
------------------------------+----------------------------------------

Changes (by Natalia Bidart):

* stage: Unreviewed => Accepted
* version: 5.1 => dev

Comment:

Thank you Edmund, patch looks great!
--
Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:2>

[Django]

#36162: Docs make black doesn't work on MacOS

-------------------------------------+-------------------------------------

Reporter: Mike Edmunds | Owner: Mike
| Edmunds
Type: Bug | Status: assigned
Component: Packaging | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:3>

[Django]

#36162: Docs make black doesn't work on MacOS
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner: Mike
| Edmunds

Type: Bug | Status: closed
Component: Packaging | Version: dev
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by GitHub <noreply@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"248d8457cbec631ef93d76137bc621106347adda" 248d8457]:
{{{#!CommitTicketReference repository=""
revision="248d8457cbec631ef93d76137bc621106347adda"
Fixed #36162 -- Fixed the `black` Makefile docs rule to work on macOS.

The `make black` target in the docs directory used Linux-specific
syntax for its `find` command. Changed to syntax that also works
on macOS and other BSD Unix variants.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:4>

[Django]

#36162: Docs make black doesn't work on MacOS
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner: Mike
| Edmunds
Type: Bug | Status: closed
Component: Packaging | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Natalia <124304+nessita@…>):

In [changeset:"e939cffa504837d90cf2958306f57649ee6a8323" e939cff]:
{{{#!CommitTicketReference repository=""
revision="e939cffa504837d90cf2958306f57649ee6a8323"
[5.2.x] Fixed #36162 -- Fixed the `black` Makefile docs rule to work on

macOS.

The `make black` target in the docs directory used Linux-specific
syntax for its `find` command. Changed to syntax that also works
on macOS and other BSD Unix variants.

Backport of 248d8457cbec631ef93d76137bc621106347adda from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:5>

[Django]

#36162: Docs make black doesn't work on MacOS
-------------------------------------+-------------------------------------
Reporter: Mike Edmunds | Owner: Mike
| Edmunds
Type: Bug | Status: closed
Component: Packaging | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Natalia <124304+nessita@…>):

In [changeset:"76b4fb74ce8219db0444e896218e39f3abbf3f0c" 76b4fb74]:
{{{#!CommitTicketReference repository=""
revision="76b4fb74ce8219db0444e896218e39f3abbf3f0c"
[5.1.x] Fixed #36162 -- Fixed the `black` Makefile docs rule to work on

macOS.

The `make black` target in the docs directory used Linux-specific
syntax for its `find` command. Changed to syntax that also works
on macOS and other BSD Unix variants.
Backport of 248d8457cbec631ef93d76137bc621106347adda from main.
}}}
--

Ticket URL: <https://code.djangoproject.com/ticket/36162#comment:6>