Remove NEWS.md from the PDF of the manual #36312
Conversation
This removes the NEWS.md link at the bottom of the first page of the manual. Given that we link to it prominently on top of the page, I feel this is ok. This will remove Section II of the PDF manual, where the release notes take 15 pages (because ofthe way markdown gets converted to PDF).
ViralBShah
changed the title
ViralBShah
added
domain:docs
|
Won't this break the link to the release notes in the html version? |
|
My understanding is that it won't generate the link to the release notes at the bottom of the page, but we still have the link to release notes on the top. |
|
Verified. With this commit, the link at the bottom goes to "Getting Started" instead of "NEWS". |
|
I'll merge this tomorrow unless there are objections. |
|
How often does the 1.6-Dev documentation on docs.julialang.org get generated/updated? The pdf there has a date of May 8. |
|
This removed the NEWS section from the menu when you click release notes:
Pretty much what I meant with #36312 (comment). Felt like this was a pretty quick merge when the asked reviewer didn't have time to review and this PR changed significantly after one person looked at it. The PR now also does a lot more than what the PR title implies. |
|
Please explain what you found misleading in the PR title. What more does it do than what it said? I didn't realize the NEWS showed up in the menu - that's not how I understood your comment. That UI is quite strange - but anyways, I can add that back. |
|
It seems like it changes some headings in the PDF now as well. |
|
If something is wrong, let me know and I'll fix it in the PR I make to reinstate the release notes in the html version. |
|
The pdf on the latest docs (if it has updated) looks like:
I don't know if it looked like that before? Maybe it is an old pdf. |
|
Where are you looking for the PDF on the latest docs? On docs.julialang.org, when I pick 1.6-dev, that PDF is quite old. |
|
Did it look fine on your locally built version? |
|
I think it did. But I am building again to see what happens. |
|
Before, there were 20 pages of Release notes, because of the way Markdown gets converted into latex. This removes the release notes from the PDF version, and merges the Introduction into the manual. |
|
I think you have an old PDF. This is what it looks locally. |
|
Yeah, I just got the one from the website which I guess hasn't updated. |
|
Right - it has the date of May 8, 2020. Something seems to have broken somewhere a while ago. |
|
The reason you see all those sections empty is because the NEWS file was probably empty after we branched. But even when the Release notes exist, those sections often have very little text in them. So you have to scroll through almost 50 pages (many empty) from page 1 of the PDF to get to the manual. |
|
I wonder if |
|
Follow-up PR: #36333 |
* Partial fix for #35495 This removes the NEWS.md link at the bottom of the first page of the manual. Given that we link to it prominently on top of the page, I feel this is ok. This will remove Section II of the PDF manual, where the release notes take 15 pages (because ofthe way markdown gets converted to PDF). * Better layout for the generated PDF (cherry picked from commit 43fd66c)
* Partial fix for JuliaLang#35495 This removes the NEWS.md link at the bottom of the first page of the manual. Given that we link to it prominently on top of the page, I feel this is ok. This will remove Section II of the PDF manual, where the release notes take 15 pages (because ofthe way markdown gets converted to PDF). * Better layout for the generated PDF
This removes the NEWS.md link at the bottom of the first page of the
manual. Given that we link to it prominently on top of the page, I
feel this is ok.
This will remove Section II of the PDF manual, where the release notes
take 15 pages (because ofthe way markdown gets converted to PDF).
Partial fix for #35495