You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributing/setup-build.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ myst:
9
9
10
10
(setup-build-label)=
11
11
12
-
# Building and Checking the Quality of Documentation
12
+
# Building and checking the quality of documentation
13
13
14
14
This document covers how to build the Plone Documentation and check it for quality.
15
15
@@ -48,25 +48,25 @@ This is an easy way to become a contributor to Plone.
48
48
```
49
49
50
50
51
-
```{note}
52
-
If you are using an M1 Mac to build the documentation, there is currently [an issue with pyenchant](https://github.com/pyenchant/pyenchant/issues/265) that throws an error that the enchant library can't be found.
53
-
This happens for example if you install Python 3 with `pyenv` in the default M1 architecture (aarch64), so without following instructions to use Rosetta2 x86 emulation.
54
-
A workaround until pyenchant is fixed is to run `export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib` in the terminal session before you execute `make html`.
55
-
```
51
+
(setup-build-installation-graphviz-label)=
56
52
57
-
Install [Graphviz](https://graphviz.org/download/) for graph visualization.
53
+
### Graphviz
58
54
59
-
**macOS**
55
+
Install [Graphviz](https://graphviz.org/download/) for graph visualization.
Copy file name to clipboardExpand all lines: docs/glossary.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -511,22 +511,24 @@ Zope Component Architecture
511
511
The ZCA is not specific to the Zope web application server.
512
512
It can be used for developing any Python application.
513
513
Maybe it should be called Python Component Architecture.
514
-
For more info read: https://muthukadan.net/docs/zca.html
514
+
```{seealso}
515
+
See also https://muthukadan.net/docs/zca.html.
516
+
```
515
517
516
518
browser layer
517
519
Layer
518
-
A layer, or also called browser layer, is a marker interface and used in ZCML configurations.
520
+
A layer—also called "browser layer"—is a marker interface and used in ZCML configurations.
519
521
Layers allow you to enable and disable views and other site functionality based on installed add-ons and themes.
520
522
521
523
JSON
522
-
JSON (JavaScript Object Notation, pronounced /ˈdʒeɪsən/; also /ˈdʒeɪˌsɒn/) is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of attribute–value pairs and arrays (or other serializable values).
524
+
JSON (JavaScript Object Notation, pronounced /ˈdʒeɪsən/; also /ˈdʒeɪˌsɒn/) is an open standard file format and data interchange format that uses human-readable text to store and transmit data objects consisting of attribute-value pairs and arrays (or other serializable values).
523
525
524
526
```{seealso}
525
527
See also https://en.wikipedia.org/wiki/JSON.
526
528
```
527
529
528
-
HTTPRequest
529
-
The HTTPRequest object contains information about the current request, which also includes browser layers.
530
+
`HTTPRequest`
531
+
The `HTTPRequest` object contains information about the current request, which also includes browser layers.
530
532
531
533
interface
532
534
An interface is a mechanism for labeling objects as conforming to a given API or contract.
0 commit comments