Skip to content

Commit

Permalink
Added note about katex install for building docs (#81550) (#81550)
Browse files Browse the repository at this point in the history
Summary:
Currently, the version of katex that npm installs
and the version of nodejs that is installed by conda
from conda-forge are incompatible. This note describes
which version of katex to install to avoid this

Pull Request resolved: #81550
Approved by: https://github.com/Lezcano, https://github.com/kit1980

Test Plan: contbuild & OSS CI, see https://hud.pytorch.org/commit/pytorch/pytorch/e100e6fd4f92794a88bbcf06da23baad289b10dc

Reviewed By: DanilBaibak

Differential Revision: D37919528

Pulled By: DanilBaibak

fbshipit-source-id: 2a6e2803f2f9f51f89d23725751e83052dcd1937
  • Loading branch information
fdrocha authored and facebook-github-bot committed Jul 18, 2022
1 parent f2f79fc commit 9f28f17
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -467,12 +467,20 @@ pip install -r requirements.txt
# Or if you prefer an uncontaminated global executable environment or do not want to go through the node configuration:
# npm install katex && export PATH="$PATH:$(pwd)/node_modules/.bin"
```
> Note: if you installed `nodejs` with a different package manager (e.g.,
`conda`) then `npm` will probably install a version of `katex` that is not
compatible with your version of `nodejs` and doc builds will fail.
A combination of versions that is known to work is `node@6.13.1` and
`katex@0.13.18`. To install the latter with `npm` you can run
```npm install -g katex@0.13.18```


> Note that if you are a Facebook employee using a devserver, yarn may be more convenient to install katex:
```bash
yarn global add katex
```
> If a specific version is required you can use for example `yarn global add katex@0.13.18`.
3. Generate the documentation HTML files. The generated files will be in `docs/build/html`.

Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,13 @@ You can then build the documentation by running `make <format>` from the
If you get a katex error run `npm install katex`. If it persists, try
`npm install -g katex`

> Note: if you installed `nodejs` with a different package manager (e.g.,
`conda`) then `npm` will probably install a version of `katex` that is not
compatible with your version of `nodejs` and doc builds will fail.
A combination of versions that is known to work is `node@6.13.1` and
`katex@0.13.18`. To install the latter with `npm` you can run
```npm install -g katex@0.13.18```

### Previous Versions

Installation instructions and binaries for previous PyTorch versions may be found
Expand Down

0 comments on commit 9f28f17

Please sign in to comment.