Documentation project for NetXMS

This repository contains the source files for the official NetXMS documentation.

NXSL (scripting) documentation sources are in the separate repository.

Components of the documentation are stored in the following directories:

• admin/ - In-depth administrator guide.
• concept/ - System concept, architecture, and terminology (partially outdated and moved to admin guide).
• developer/ - Describes development process and possible ways of extending NetXMS.
• user/ - User guide covering basic concepts, management console, objects, and topology.
• manpages/ - UNIX man pages.

Notes

Prerequisites

macOS

brew install --cask basictex
sudo tlmgr update --self
sudo tlmgr install latexmk capt-of ellipse fncychap framed needspace pict2e tabulary tex-gyre titlesec varwidth wrapfig gnu-freefont

Ubuntu/Mint

apt install python3-pip python3-virtualenv latexmk texlive-latex-extra texlive-xetex xindy git

Preparing the environment

git clone https://github.com/netxms/netxms-doc
cd netxms-doc
uv sync

Building locally

uv run make html pdf

Automatic rebuild and reload

cd admin
uv run sphinx-autobuild -b html . _build/html

Building with Docker

make docker        # build the Docker image
make docker-push   # build and push multi-arch image

Building translated version:

Note: translated documentation is not updated anymore and is kept for reference only.

make gettext
sphinx-intl update -p _build/locale -l ru
sphinx-intl build
make -e SPHINXOPTS="-D language=ru" html

Useful links

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html