-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
docs: Cosmetic & functional fixes to comply with PDF generation req. #1446
Conversation
Converted it as a draft PR since it is still WIP |
I see you replaced my no-breaking hyphens with breaking hyphens (unicode inspect).
The pdf tool does not support unicode or this unicode character? |
Indeed, they don't support no-breaking hyphens. So far, I think only this unicode character is not supported. If no-breaking hyphens is messing up the page rendering (which in my case when I rendered the page it didn't, everything was fine), I will treat this case in code. Also, there're a few math formulas that don't render well too. This PR is only a draft and has the purpose to fix .rst mistakes so that no extra code for doctools is needed. For example, math formulas needed correction only in .rst. No need to implement correction mechanism in doctools. |
I found out that separating
If separated like this (also added '\' before '_{before}' ):
The PDF generation will be okay. Even the HTML page will look fine. |
684fc6c
to
cd04cbf
Compare
docs/library/axi_ad485x: Tag <#hdl-regmap-DELAY_CNTRL> needs to be fixed Will be changed to <#hdl-regmap-IO_DELAY_CNTRL> (the redirect to the below content will work then). Apparently tags likes this which are not working mess up the whole PDF generation (document is not readable by any program). |
- Fixed '-' chars that would mess up the PDF generation - Fixed a few math formulas that don't render well in PDF format - Fixed a tag in library/axi_ad485x that would mess up the whole PDF generation Signed-off-by: Cristian Mihai Popa <cristianmihai.popa@analog.com>
cd04cbf
to
e4a6a1b
Compare
- Added the configuration so that the user can ouput the whole document in PDF Signed-off-by: Cristian Mihai Popa <cristianmihai.popa@analog.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add rst2pdf.pdfbuilder to requirements.txt also
Signed-off-by: Cristian Mihai Popa <cristianmihai.popa@analog.com>
63bea54
to
1e33f31
Compare
The purpose of this PR is to fix typos & mistakes that mess up the PDF generation of the doc. More changes will be added as soon as they are caught. PDF generation method is still in progress & is tested on a certain batch of pages that have different functionalities (collapsible content, math formulas etc.).
Doctools PDF output method PR was merged into main (analogdevicesinc/doctools#18).
PR Type
PR Checklist