Lightning-AI / Lightning-AI/pytorch-lightning

building docs to pdf

Open
#17,303 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug docs ver: 2.0.x ver: 2.1.x
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

### Bug description

I wanted to read the latest docs offline and find/build a pdf of the docs.
On an MBP M1, I did `brew install sphinx`, then `cd docs/` then `pip install -r requirements.txt` which all completed successfully.

No `make` command appears to run without error however.

### What version are you seeing the problem on?

latest

### How to reproduce the bug

try to produce docs without error using

make text
make singlehtml
make latexpdf
make latexpdfja

### Error messages and logs

For example, `make singlehtml` yields a lot of output then finally:

```
FileNotFoundError: [Errno 2] No such file or directory: 'katex'

Exception occurred:
File "/Users/aaelony/mambaforge/envs/py39tt/lib/python3.9/subprocess.py", line 1821, in _execute_child
raise child_exception_type(errno_num, err_msg, err_filename)
FileNotFoundError: [Errno 2] No such file or directory: 'katex'
The full traceback has been saved in /var/folders/jc/5gc6fmf52cv6r88m6snhvvlr0000gn/T/sphinx-err-417jlpa9.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at . Thanks!
```
[make--latexpdf.log](https://github.com/Lightning-AI/lightning/files/11181605/make--latexpdf.log)

[make--singlehtml.log](https://github.com/Lightning-AI/lightning/files/11181611/make--singlehtml.log)

### Environment

Current environment

```
#- Lightning Component (e.g. Trainer, LightningModule, LightningApp, LightningWork, LightningFlow):
#- PyTorch Lightning Version (e.g., 1.5.0):
#- Lightning App Version (e.g., 0.5.2):
#- PyTorch Version (e.g., 2.0):
#- Python version (e.g., 3.9):
#- OS (e.g., Linux):
#- CUDA/cuDNN version:
#- GPU models and configuration:
#- How you installed Lightning(`conda`, `pip`, source):
#- Running environment of LightningApp (e.g. local, cloud):
```

Thanks in advance.

cc @borda

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in docs/ with requirements.txt and the Makefile targets named in the report: text, singlehtml, latexpdf, and latexpdfja. Reproduce the builds, inspect the reported missing katex error and attached logs, then verify that the documentation targets complete without errors on the reported environment.

Written by the indexing model from the issue text.

Assessment

Tech stack
latex, python
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.