Skip to content

Commit

Permalink
Prettier docs (#28)
Browse files Browse the repository at this point in the history
To get a cleaner diff when adding v2.3.1.1 docs, this is a preliminary
PR applying `prettier` formatting of all relevant files.
  • Loading branch information
thejspr authored May 29, 2024
1 parent 08d0e1f commit 351fe32
Show file tree
Hide file tree
Showing 31 changed files with 25,508 additions and 16,596 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ The spec is currently at version 2.2.0.

The documentation is currently generated by Sphinx. It can be generated locally with:

docker run --rm -v $PWD:/opt -w /opt -e USER_ID=$UID ddidier/sphinx-doc:2.2.1-1 sphinx-build -b html source build
docker run --rm -v $PWD:/opt -w /opt -e USER_ID=$UID ddidier/sphinx-doc:2.2.1-1 sphinx-build -b html source build

The generated documentation is then rooted in `build/index.html`.

## Code formatting

The code is formatted with Prettier. To format the code, run:

```
npm install -g prettier
prettier . --write --bracket-same-line
```
Loading

0 comments on commit 351fe32

Please sign in to comment.