Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netxms/netxms-doc
Documentation for NetXMS project
https://github.com/netxms/netxms-doc
Last synced: about 2 months ago
JSON representation
Documentation for NetXMS project
- Host: GitHub
- URL: https://github.com/netxms/netxms-doc
- Owner: netxms
- License: other
- Created: 2015-01-07T11:17:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-11-11T14:16:09.000Z (about 2 months ago)
- Last Synced: 2024-11-11T15:25:11.050Z (about 2 months ago)
- Language: Makefile
- Size: 45.1 MB
- Stars: 11
- Watchers: 8
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Documentation project for NetXMS
This repository contains the source files for the official [NetXMS](https://netxms.com) documentation.
NXSL (scripting) documentation sources are in the [separate repository](https://github.com/netxms/nxsl-doc).
Components of the documentation are stored in the following directories:
- concept/ - System concept, architecture, and terminology (partially outdated and moved to admin guide).
- admin/ - In-depth administrator guide.
- developer/ - Describes development process and possible ways of extending NetXMS.
- manpages/ - UNIX man pages.
# Notes
## Prerequisites
### macOS
```shell
brew cask install basictex
sudo tlmgr update --self
sudo tlmgr install latexmk fncychap titlesec tabulary varwidth framed wrapfig capt-of needspace helvetic courier letltxmacro tex-gyre
```
### Ubuntu/Mint
```shell
apt install python3-pip python3-virtualenv latexmk texlive-latex-extra git
```
## Preparing the environment
```shell
git clone https://github.com/netxms/netxms-doc
python3 -m venv sphinx # create virtualenv, do it once
source sphinx/bin/activate # activate virtualenv
pip3 install -r requirements.txt # install dependencies, do it once
```
## Building locally
```shell
cd netxms-doc
source sphinx/bin/activate # activate virtualenv
make html pdf
```
## Automatic rebuild and reload
```shell
cd netxms-doc
cd admin
sphinx-autobuild -b html . _build/html
```
## Building translated version:
Note: translated documentation is not updated anymore and is kept for reference only.
```shell
make gettext
sphinx-intl update -p _build/locale -l ru
sphinx-intl build
make -e SPHINXOPTS="-D language=ru" html
```
# Useful links
http://sphinx-doc.org/markup/para.html
http://sphinx-doc.org/markup/inline.html
http://sphinx-doc.org/markup/