-
Notifications
You must be signed in to change notification settings - Fork 580
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
gh-958 Use Asciidoctor's PDF generation #1009
Conversation
* Remove docbook-based Maven tool-chain * Ensure Spring Cloud Data Flow logo shows up on PDF cover-page * Ensure Spring Cloud Data Flow version-number shows up on PDF cover-page * Ensure that PDF and HTML docs are bundled up correctly
Just for reference - Looks like there are a ton of fixes in the underlying |
@@ -361,13 +214,16 @@ | |||
</goals> | |||
<configuration> | |||
<target> | |||
<copy file="${project.build.directory}/generated-docs/index.pdf" tofile="${project.build.directory}/contents/reference/pdf/spring-cloud-dataflow-reference.pdf" /> | |||
<copy todir="${project.build.directory}/contents/reference/html"> |
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.
I think now that docbook is dropped, it would be better to forget about that contents
directory that misleads everyone. Generated docs should be in generated-docs
, period. Then, build the zip from there. WDYT?
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.
Could even argue that the assembly plugin is a more natural fit...
The |
Could force a page break with |
Looks like there is a way to configure custom dependency versions: |
* Remove docbook contents * Add basic theme-template * Polish theme
Made some changes:
Not sure yet on the section titles. Also, not sure about using the |
Still, I think we should follow the principle of least astonishment. We can cherry pick the files we want in the zip easily. Will have a look at this new commit and maybe incorporate the final changes myself (looks like conditional pagebreaks is the best workaround for now) |
@@ -168,6 +168,8 @@ | |||
<backend>pdf</backend> | |||
<sourceHighlighter>rouge</sourceHighlighter> | |||
<attributes> | |||
<pdf-stylesdir>${project.basedir}/src/main/asciidoc/pdf-theme</pdf-stylesdir> |
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.
We could move the theme out of the asciidoc
directory (maybe as a sibling asciidoc-pdf-theme
) so that it does not end up in the generated-docs
dir
Merged as f707c9b, which includes ericbottard@2e1b093 Seems like asciidoctor-pdf-alpha13 includes a fix for pagebreaks. Sadly, its -J version is not published on maven yet. |
Resolves #958