database/mariadb-columnstore-engine
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-columnstore-engine.git synced 2026-10-23 21:49:05 +03:00
Code Activity
Files
1071df26f2b434c069d0fff72a16100486239855
mariadb-columnstore-engine/cmapi/mcs_cluster_tool/README_DEV.md
mariadb-AlanMologorsky 8e50884928 MCOL-5526: CLI rename "mcs CLUSTER" commands to just mcs. 
[add] now all 'cluster' subcommand commands working without using 'cluster' subcommand itself
[fix] 'cluster' command hidding its help message
[add] explicit names for commands
[add] help-all command to list all nested help messages in man page view
[add] rich colored tabled help
[add] table panels for cluster commands
[upd] typer dependency version and some extra indirect dependencies
[add] README.md for mcs cli tool with all command reference
[add] mcs.1 man page
[add] README_DEV.md for mcs cli tool
[fix] cmapi/CMakeLists.txt to install mcs.1 man page
2025-03-07 01:51:31 +03:00

532 B
Raw Blame History

Generating documentation for MCS cli tool

  • install cmapi requirements 
    pip install -r requirements.txt
  • generate markdown 
    typer mcs_cluster_tool/__main__.py utils docs --name mcs --output README.md
  • install md2man (for now it's the only one tool that make convertation without any issues) 
    sudo yum install -y ruby ruby-devel
gem install md2man
  • convert to perfect .roff file (man page) 
    md2man README.md > mcs.1
  • enjoy =)
View Git Blame Copy Permalink