Chat with DeepWiki to get answers about the Comindware Plafrom from this repo:

Ask DeepWiki

This is the MkDocs repository with source files for the RU CMW knowledge base.

1. Install Python:

   • Change dir to Help under the solution root directory.

   • Run:

     ./install/installpy.ps1

     or

     sh install/install.sh

     • This script downloads and installs the latest Python from python.org (including the pip package manager).
     • install.sh also installs GTK3 framework used for PDF output.
     • In Windows, UAC request may pop-up during the silent installation.

1. Initialize Python virtual environment, an install MkDocs with dependencies:

   ./install/deploymkdocs.ps1

   or

   sh install/deploy.sh

1. Run:

   ./buildhelp.ps1

   or

   sh buildhelp.sh

   • This script runs buildhelp.py in the virtual environment and builds languages help to compiled_help.

   • The language list is set on the line 15 in buildhelp.py:

     LANGUAGE_LIST = ["en", "ru"]

2. You should see the newly compiled help subdirectories in the compiled_help directory:

   • en
   • ru

1. Install GTK3: installgtk3.ps1 or apt install -y libgtk-3-dev.

   [!NOTE] In Windows, for GTK3 to work properly the PATH variable might need to be set (and put on top of the PATH list) to its installation directory.

2. Build the PDF manual:

   mkdocs build -f mkdocs_ru_pdf.yml

You can view the live MkDocs site without building it or compiling the product. The live server watches for changes in the docs folder and update accordingly.

Serve Russian docs locally at http://127.0.0.1:8000

1. Change dir to Help under the solution root directory.

2. Run:

   ./install/deploymkdocs.ps1

   or

   sh install/deploy.sh

   • This script deploys the Python virtual environment in Help/venv with MKDocs and its dependencies listed in the requirements.txt file. It does not build the help files.

3. Run:

   mkdocs serve

   or

   py -m mkdocs serve

   • For English version run:

     mkdocs serve -f mkdocs_en_local.yml
     

The files will be compiled to the for_kb_import_ru or for_kb_import_en folder.

The kb_html_cleanup_hook.py does all the magic.

mkdocs build -f mkdocs_for_kb_import_ru.yml

or

mkdocs build -f mkdocs_for_kb_import_en.yml

• install\uninstallmkdocs.ps1 — uninstalls installs all MKDocs dependencies listed in the requirements.txt config file.

• install\uninstallpy.ps1 — silently uninstalls Python, runs a single command: .\python_latest.exe /uninstall /quiet

The help is powered by the very popular and well-maintained MkDocs framework: https://squidfunk.github.io/mkdocs-material/ https://github.com/squidfunk/mkdocs-material https://www.mkdocs.org/

If awesome-pages plugin is enabled you can selectively enable only certain documentation folders in the mkdocs.yml, for instance:

nav:
  - ... | administration/**
  - ... | using_the_system/**