Page MenuHomeSoftware Heritage

Integrate swh-graph javadoc in swh-docs
Closed, MigratedEdits Locked

Description

Currently there is only external RST and Python documentation from swh-graph which are integrated in https://docs.softwareheritage.org/devel/swh-graph/. The javadoc from the Java server should be hosted there too.

Javadoc is already generated locally in the swh-graph repo with 81b6c0032c8c, however we need to find a way to copy it as static pages in swh-docs. What was tried so far:

  • Using Sphinx html_static_path. Problem: it cannot copy the whole folder as is, and only outputs the content of the javadoc folder in _static.
  • Using Sphinx html_extra_path. Problem: same as above, expect now it is scattered in the root build directory.
  • Using Sphinx extension rawfiles. Problem: cannot control where the folder is copied (it defaults to the swh-graph/docs folder...).

A simple cp command in swh-docs Makefile can do the trick, but we need a generic way of adding files/folder in the swh-docs build directory.