README updated
This commit is contained in:
parent
cb4d9799c5
commit
ed723d101e
2 changed files with 53 additions and 26 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -7,4 +7,4 @@
|
||||||
.vscode
|
.vscode
|
||||||
.vscode
|
.vscode
|
||||||
_build
|
_build
|
||||||
_build_html
|
sphinx
|
||||||
|
|
77
README.md
77
README.md
|
@ -1,48 +1,75 @@
|
||||||
# Documentation project for NetXMS
|
# Documentation project for NetXMS
|
||||||
|
|
||||||
Components:
|
This repository contains the source files for the official [NetXMS](https://netxms.com) documentation.
|
||||||
|
|
||||||
- concept/ - System concept, architecture, and terminology.
|
NXSL (scripting) documentation sources are in the [separate repository](https://github.com/netxms/nxsl-doc).
|
||||||
- admin/ - In-depth administrator guide.
|
|
||||||
- developer/ - Describes development process and possible ways of extending NetXMS.
|
Components of the documentation are stored in the following directories:
|
||||||
- manpages/ - UNIX man pages.
|
|
||||||
|
- 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
|
# Notes
|
||||||
|
|
||||||
## Local setup
|
## Prerequisites
|
||||||
|
|
||||||
- mkvirtualenv sphinx
|
### macOS
|
||||||
- workon sphinx
|
|
||||||
- pip install -r requirements.txt
|
|
||||||
|
|
||||||
## Ubuntu/Mint
|
```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
|
||||||
|
```
|
||||||
|
|
||||||
- apt install python3-pip python3-virtualenv latexmk texlive-latex-extra git
|
### Ubuntu/Mint
|
||||||
- git clone https://github.com/netxms/netxms-doc
|
|
||||||
- cd netxms-doc
|
|
||||||
- python3 -m virtualenv .
|
|
||||||
- . bin/activate # activate virtualenv
|
|
||||||
- pip install -r requirements.txt
|
|
||||||
|
|
||||||
## macOS specific
|
```shell
|
||||||
|
apt install python3-pip python3-virtualenv latexmk texlive-latex-extra git
|
||||||
|
```
|
||||||
|
|
||||||
- brew cask install basictex
|
## Preparing the environment
|
||||||
- sudo tlmgr update --self
|
|
||||||
- sudo tlmgr install latexmk fncychap titlesec tabulary varwidth framed wrapfig capt-of needspace helvetic courier letltxmacro tex-gyre
|
```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
|
## Automatic rebuild and reload
|
||||||
|
|
||||||
- cd admin && sphinx-autobuild . \_build_html
|
```shell
|
||||||
|
cd netxms-doc
|
||||||
|
cd admin
|
||||||
|
sphinx-autobuild -b html . _build/html
|
||||||
|
```
|
||||||
|
|
||||||
## Building translated version:
|
## Building translated version:
|
||||||
|
|
||||||
- make gettext
|
Note: translated documentation is not updated anymore and is kept for reference only.
|
||||||
- sphinx-intl update -p \_build/locale -l ru
|
|
||||||
- sphinx-intl build
|
```shell
|
||||||
- make -e SPHINXOPTS="-D language=ru" html
|
make gettext
|
||||||
|
sphinx-intl update -p _build/locale -l ru
|
||||||
|
sphinx-intl build
|
||||||
|
make -e SPHINXOPTS="-D language=ru" html
|
||||||
|
```
|
||||||
|
|
||||||
# Useful links
|
# Useful links
|
||||||
|
|
||||||
http://sphinx-doc.org/markup/para.html
|
http://sphinx-doc.org/markup/para.html
|
||||||
|
|
||||||
http://sphinx-doc.org/markup/inline.html
|
http://sphinx-doc.org/markup/inline.html
|
||||||
|
|
||||||
http://sphinx-doc.org/markup/
|
http://sphinx-doc.org/markup/
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue