module serverdoc.server_helper

Short summary

module pyquickhelper.serverdoc.server_helper

Helpers about a documentation.

source on GitHub

Functions

function

truncated documentation

get_jenkins_mappings

we assume jobs were set up through a jenkins server, the function looks into folder root and list folder root/.*/dist/html.*

Documentation

Helpers about a documentation.

source on GitHub

pyquickhelper.serverdoc.server_helper.get_jenkins_mappings(root, loc='dist')[source][source]

we assume jobs were set up through a jenkins server, the function looks into folder root and list folder root/.*/dist/html.*

Parameters
  • root – folder or list of folders or list of tuple (prefix, folder)

  • locdist by default (dist in the folder mentioned above), it could also be _doc/sphinxdoc/build

Returns

dictionary { “name”:folder }

source on GitHub