Skip to content

Issue with documentation #9320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
kov-serg opened this issue Mar 2, 2024 · 3 comments · Fixed by #9343
Closed
1 task done

Issue with documentation #9320

kov-serg opened this issue Mar 2, 2024 · 3 comments · Fixed by #9343
Assignees
Labels
Type: Bug 🐛 All bugs Type: Documentation Issue pertains to Documentation of Arduino ESP32

Comments

@kov-serg
Copy link

kov-serg commented Mar 2, 2024

Board

any

Device Description

any

Hardware Configuration

any

Version

v2.0.14

IDE Name

any

Operating System

ubuntu 22

Flash frequency

any

PSRAM enabled

yes

Upload speed

115200

Description

Code lines are overlapping page boundaries:

Sketch

// any

Debug Message

// none

Other Steps to Reproduce

git clone --depth=1 https://github.com/espressif/arduino-esp32.git
cd arduino-esp32/docs/
build-docs -l en -bs latex

arduino-esp32doc-2.0.14.pdf

I have checked existing issues, online documentation and the Troubleshooting Guide

  • I confirm I have checked existing issues, online documentation and Troubleshooting guide.
@kov-serg kov-serg added the Status: Awaiting triage Issue is waiting for triage label Mar 2, 2024
@lbernstone
Copy link
Contributor

It looks weird in the web format, but does not mess up the page boundaries. Seems like a latex issue.

@kov-serg
Copy link
Author

kov-serg commented Mar 2, 2024

No this problem in documentation formatting. It should be more smart or simply fix source codes to prevent formatting issues.

html version
html version

epub version
epub version

in epub and html we can scroll this text, but in printed pdf we cann't. And can be fixed using css:

.section pre {
  max-width: 53em;
  white-space: break-spaces !important
}

@VojtechBartoska VojtechBartoska added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Mar 4, 2024
@lucasssvaz
Copy link
Collaborator

There are mixed spaces and tabs in the indentation. I'll open a PR to fix it.

@lucasssvaz lucasssvaz added Type: Bug 🐛 All bugs and removed Status: Awaiting triage Issue is waiting for triage labels Mar 5, 2024
@lucasssvaz lucasssvaz self-assigned this Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug 🐛 All bugs Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants