database/mariadb-columnstore-engine
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-columnstore-engine.git synced 2025-07-29 08:21:15 +03:00
Code Activity
Files
coordinator-nodes
mariadb-columnstore-engine/cmapi/mcs_cluster_tool/README_DEV.md
mariadb-AlanMologorsky aa57a7684c feat(cmapi): MCOL-5019: review fixes. 
[fix] CEJPasswordHandler class methods to use directory for cskeys file
[fix] CEJPasswordHandler.encrypt_password to return password in hex format
[fix] CEJPasswordHandler key_length
[fix] CEJPasswordHandler os.urandom call typo
[upd] mcs cli README.md and man page
[upd] mcs cli README_DEV.md
[fix] mcs_cluster_tool/decorators.py to handle typer.Exit exception
[add] various docstrings
2025-04-08 14:56:06 +03:00

969 B
Raw Permalink 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
    Optionally could be generated from installed package. 
    PYTHONPATH="/usr/share/columnstore/cmapi:/usr/share/columnstore/cmapi/deps" /usr/share/columnstore/cmapi/python/bin/python3 -m  typer /usr/share/columnstore/cmapi/mcs_cluster_tool/__main__.py utils docs --name mcs --output ~/README.md
  • dependencies for gem build (RHEL example) 
    sudo dnf install make gcc redhat-rpm-config -y
  • 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-roff README.md > mcs.1
  • enjoy =)