Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 2.2 KB

README.md

File metadata and controls

40 lines (24 loc) · 2.2 KB

sql-query-clients Actions Status Actions Status

This repository contains application client samples and blueprint code for the IBM Cloud Data Engine service.

List of clients

Documentation

How to generate docs

Requirement: conda

  • In the docs folder, you run [if you don’t have sphinx and required package yet]

make setup

This create sphinx environment. Make sure you're in this environment each time you run the below commands

  • Get docstring updated

make python

  • generate docs in local file (in /tmp/sql-query-clients-docs/html - for the purpose of local check the output)

make html

Check the output by opening the browser with the URL: file:///tmp/sql-query-clients-docs/html/index.html

  • (check the local content carefully before running this) generate and commit to the server [only those with proper priviledges]

make buildandcommithtml