[MCOL-1439] Documentation for Python API missing Created: 2018-05-22  Updated: 2023-10-26  Resolved: 2018-07-17

Status: Closed
Project: MariaDB ColumnStore
Component/s: None
Affects Version/s: 1.1.4
Fix Version/s: 1.1.6

Type: Task Priority: Critical
Reporter: Anders Karlsson Assignee: Daniel Lee (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Environment:

Linux

Sprint: 2018-14

 Description   

There seems that documentation for the Python Data Ingestion API is largely missing. The C++ API is well documented, but Python and Java seems missing.

 Comments   
Comment by Jens Röwekamp (Inactive) [ 2018-07-11 ]

Added documentation for pymcsapi and javamcsapi and added it to the build pipeline.

Needed to introduce following new dependencies:

  • Sphinx version >= 1.7.5 is required to support automated line breaks in code blocks in generated PDFs.
  • javasphinx is needed to extend Sphinx with the Java domain.

Both should be installed through pip3 instead of the operating system's package manger to get the newer versions. I updated the top level README.md accordingly.

For QA:

  • Test if the updated dependency install commands in README.md work on all OSes.
  • Build and install the new documentations on all OSes through: 

    cmake -DBUILD_DOCS=ON -DSPARK_CONNECTOR=OFF .
    		 
    make -j2
    		 
    sudo make install

  • Verify that the generated documentations (HTML and PDFs) are readable.
Comment by Daniel Lee (Inactive) [ 2018-07-17 ]

Build verified: 1.1.6-1 source

/root/mariadb-columnstore-api
commit 4133c262f4b58f2ed49d69181a4b295d4c2f6764
Merge: 29a7e06 e231c95
Author: Andrew Hutchings <andrew@linuxjedi.co.uk>
Date: Thu Jul 12 11:55:20 2018 +0100

Merge pull request #90 from mariadb-corporation/MCOL-1439

MCOL-1439 - pymcsapi and javamcsapi documentation

Generated at Thu Feb 08 02:28:46 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.