Enunciate

Enunciate fail to generate html pages with a custom docs.xml.fmt

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.25
  • Fix Version/s: 1.26
  • Component/s: documentation
  • Labels:
    None
  • Number of attachments :
    0

Description

With a custom docs.xml.fmt no html pages are generated into the docs dir target.
Other files are present (xml, css, js, etc)

The docs.xml.fmt used can be found at this address:
https://github.com/stoicflame/enunciate/blob/v1.25/docs/src/main/resources/org/codehaus/enunciate/modules/docs/docs.xml.fmt

Below the enunciate.xml:
<enunciate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.25.xsd">
<services>
<rest defaultRestSubcontext="/api" />
</services>
<modules>
<docs docsDir="target/doc" css="css/custom.css" freemarkerXMLProcessingTemplate="web/webapp-api/src/main/webapp/META-INF/enunciate/docs.xml.fmt" />
</modules>
</enunciate>

Note that I have to indicate the path to the docs.xml.fmt from the root of the application whereas the custom css path is relative to enunciate.xml location.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Ryan Heaton added a comment -

Sorry, can you clarify what the expected behavior is? The "docsDir" attribute is used to specify the subdirectory in which the documentation will be placed relative to the root of the webapp, when the webapp gets built.

Show
Ryan Heaton added a comment - Sorry, can you clarify what the expected behavior is? The "docsDir" attribute is used to specify the subdirectory in which the documentation will be placed relative to the root of the webapp, when the webapp gets built.
Hide
Permalink
draiwn added a comment -

The issue occurs with freemarkerXMLProcessingTemplate attribute, the docsDir is not involved.

Without custom docs.xml.fmt, the documentation is generated normally, with all resources (css, js, xml, etc) and html pages (index.html, model.html, resource_**.html, etc). All works perfectly.

With custom docs.xml.fmt, no html pages are generated but other resources are present.

Show
draiwn added a comment - The issue occurs with freemarkerXMLProcessingTemplate attribute, the docsDir is not involved. Without custom docs.xml.fmt, the documentation is generated normally, with all resources (css, js, xml, etc) and html pages (index.html, model.html, resource_**.html, etc). All works perfectly. With custom docs.xml.fmt, no html pages are generated but other resources are present.
Hide
Permalink
Ryan Heaton added a comment -

It's the template that writes new files. Can you share your docs.xml.fmt?

Show
Ryan Heaton added a comment - It's the template that writes new files. Can you share your docs.xml.fmt?
Hide
Permalink
draiwn added a comment -

I used the docs.xml.fmt on the enunciate repository:

https://github.com/stoicflame/enunciate/blob/v1.25/docs/src/main/resources/org/codehaus/enunciate/modules/docs/docs.xml.fmt

Show
draiwn added a comment - I used the docs.xml.fmt on the enunciate repository: https://github.com/stoicflame/enunciate/blob/v1.25/docs/src/main/resources/org/codehaus/enunciate/modules/docs/docs.xml.fmt
Hide
Permalink
Ryan Heaton added a comment -

I should have looked more closely. You template you should be using is docs.fmt not docs.xml.fmt.

However, the bug for resolving the path relative to the enunciate.xml config file is fixed at 1978c3c.

Show
Ryan Heaton added a comment - I should have looked more closely. You template you should be using is docs.fmt not docs.xml.fmt. However, the bug for resolving the path relative to the enunciate.xml config file is fixed at 1978c3c.
Hide
Permalink
Ryan Heaton added a comment -

Closed with the release of 1.26.

Show
Ryan Heaton added a comment - Closed with the release of 1.26.

People

  • Assignee:
    Ryan Heaton
    Reporter:
    draiwn
Vote (1)
Watch (3)

Dates

  • Created:
    Updated:
    Resolved: