Nuxeo Core Developer Guide

Generating documentation

Updated: October 22, 2018 Page Information Edit on GitHub

Publish Javadoc and TLD documentation

Documentation of current code is continuously built by the Jenkins job http://qa.nuxeo.org/jenkins/job/nuxeo-doc/.

For releases, run the job manually ("Build Now" link). Then change the job parameters (see parameters' description for details).

This is publishing Javadoc and TLDdoc into http://community.nuxeo.com/api/.

Publish Nuxeo product into the Explorer

  1. Start an instance of the product to publish with the explorer plugin installed (see https://github.com/nuxeo/nuxeo-apidoc-server).
  2. Connect on http://NUXEO_SERVER/nuxeo/site/distribution/, save your distribution. You may need to wait and refresh to see your saved distribution documentation available. Export your documentation as zip.
  3. Connect on http://apidoc.nuxeo.org/nuxeo/site/distribution/ and import your zip.
  4. Check your import was successful on http://explorer.nuxeo.org/nuxeo/site/distribution/.

Now, you can start to add technical documentation for that product version.

2 months ago manonlumeau NXDOC-1650 fix about integrating changes, add mention on multiple attempts
6 years ago Anahide Tchertchian 5
6 years ago Anahide Tchertchian 6 | igrated to Confluence 4.
7 years ago Julien Carsique 4
7 years ago Julien Carsique 3
7 years ago stan 2
8 years ago Julien Carsique 1
History: Created by Julien Carsique

We'd love to hear your thoughts!

All fields required