[MCOL-1533] mcsapi documentation - version history table not generated Created: 2018-07-06  Updated: 2023-10-26  Resolved: 2018-07-17

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

Type: Bug Priority: Minor
Reporter: Jens Röwekamp (Inactive) Assignee: Daniel Lee (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Environment:

Ubuntu 16

Sprint: 2018-14

 Description   

When generating the documentation through

cmake -DSPARK_CONNECTOR=OFF -DBUILD_DOCS=ON .
 
make

a "mariadb-columnstore-api/docs/_sources/changelog.rst:6: ERROR: Malformed table." error occurred and the version history is neither in the PDFs nor HTML documentation.

The rest of the documentation is built.

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

Just a simple indent malfunction.

For QA:
Build the doc and verify that the version history table is in the PDF and HTML documents.

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

diff --cc java/CMakeLists.txt
index 7ca7c2e,373a20b..544dd9f
— a/java/CMakeLists.txt
+++ b/java/CMakeLists.txt
@@@ -83,10 -83,10 +83,14 @@@ INSTALL(FILES "${CMAKE_CURRENT_BINARY_D
INSTALL(FILES build/libs/javamcsapi-${MCSAPI_VERSION_STRING}.jar DESTINATION ${CMAKE_INSTALL_LIBDIR})
INSTALL(FILES build/libs/javamcsapi.jar DESTINATION ${CMAKE_INSTALL_LIBDIR})

+ if (BUILD_DOCS)
+ add_subdirectory(docs)
+ endif (BUILD_DOCS)
+
IF(TEST_RUNNER)
+ option(JAVA_COMPATIBILITY_TEST "Run the Java mcsapi compatibility test" ON)
add_test(NAME Java_BasicTest COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/gradlew" -p ${CMAKE_CURRENT_SOURCE_DIR} -Pversion=${MCSAPI_VERSION_STRING} -Pjava.library.path=${CMAKE_CURRENT_BINARY_DIR} test)
+ IF(JAVA_COMPATIBILITY_TEST)
+ add_test(NAME JavaMcsapi_mcsapi_compatibility_test COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/test/compatibility_test.sh" ${VERSION_MAJOR} ${VERSION_MINOR} ${VERSION_PATCH})
+ ENDIF(JAVA_COMPATIBILITY_TEST)
ENDIF(TEST_RUNNER)

Verified the changelogs.rst file.

There is an issue generating pdf and html files on Centos 7. It is being tracked on MCOL-1566.

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