NextGIS documentation root repository

Root repository for NextGIS user and developer documentation

Main repositories

• Get Started with your Web GIS
• NextGIS Web
• NextGIS QGIS
• NextGIS Mobile
• NextGIS Web for developers
• NextGIS Mobile for developers
• NextGIS QMS Server for developers

To start generating documentation locally you need some packages be installed python > 2.7 and:

1. sudo pip install sphinx
2. sudo apt-get install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended
3. sudo apt-get install texlive-doc-ru texlive-lang-cyrillic texlive-fonts-extra
4. sudo pip install sphinxcontrib-httpdomain sphinx-bootstrap-theme
5. sudo apt-get install latexmk

You can install packages in virtual environment, so 1 and 4 must be executed in vetualenv:

1. source env/bin/activate
2. pip install sphinx
3. pip install sphinxcontrib-httpdomain sphinx-bootstrap-theme

You have to generate key for ssh git access. See: https://help.github.com/articles/generating-ssh-keys/

git clone --recursive git@github.com:nextgis/docs_ng.git
cd docs_ng
make html
make latexpdf

Update documentation

Documentation automaticaly updates on docs.nextgis.com after git push or edits on Github:

Build status

Dev mode

To track changes frontend-ассетов:

npm run dev

If .rst pages and Sphinx are edited simultaneously, удобно в отдельном it is convenient to run this in a separate terminal:

sphinx-autobuild source build

Translations

pybabel compile --directory=source/locale --domain=messages
pybabel compile --directory=source/locale --domain=sphinx

License

This documentaion is licensed under CC-BY-ND 3.0