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
Xdoc generation should be in mvn site phase #13426
Comments
stoyanK7
changed the title
xdoc generation should be in mvn site phase
Xdoc generation should be in mvn site phase
Jul 24, 2023
We should do this only as very last issue, as it has no much benefit to users and simply design beautification, that is also good, but we have bunch of other issues to be done first. |
That describes this whole project. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The final step of this project is to have the generation happen in
mvn site phase
. As of now, we use a@BeforeAll
method inXdocsPagesTest
to generate Xdocs. We use a custom parser, custom sink, and custom sink factory. The reason we have them is because we want to isolate macro execution from parsing the rest of the file to HTML. Once the whole repository is converted to templates and we are certain the generation is good, those 3 modules will be removed. The defaultXdocParser
inmvn site
phase will execute the macros and parse to HTML for us.please beware of #13770 fix that introduced extra overrides to doxia files that might cause extra complexity in this issue. Completing #13426 means we will be removing the classes we copied and hacked from Doxia (XdocsTemplateSink) which is documented at
checkstyle/src/main/java/com/puppycrawl/tools/checkstyle/site/XdocsTemplateSink.java
Lines 33 to 34 in f6b70cc
. When completing #13426 and removing the class, we need to re-open #13770 and find a permanent fix unless doxia resolves our internal issues at https://issues.apache.org/jira/browse/DOXIA-707 .
Interesting note at https://issues.apache.org/jira/browse/DOXIA-707
The text was updated successfully, but these errors were encountered: