You've already forked mariadb-columnstore-engine
mirror of
https://github.com/mariadb-corporation/mariadb-columnstore-engine.git
synced 2025-08-05 16:15:50 +03:00
aa57a7684c
[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
27 lines
969 B
Markdown
27 lines
969 B
Markdown
# Generating documentation for MCS cli tool
|
|
- install cmapi requirements
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
- generate markdown
|
|
```bash
|
|
typer mcs_cluster_tool/__main__.py utils docs --name mcs --output README.md
|
|
```
|
|
Optionally could be generated from installed package.
|
|
```bash
|
|
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)
|
|
```bash
|
|
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)
|
|
```bash
|
|
sudo yum install -y ruby ruby-devel
|
|
gem install md2man
|
|
```
|
|
- convert to perfect `.roff` file (`man` page)
|
|
```bash
|
|
md2man-roff README.md > mcs.1
|
|
```
|
|
- enjoy =) |