Skip to content

nextgis/docs_ng

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NextGIS documentation root repository

Root repository for NextGIS user and developer documentation

Main repositories

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 [email protected]:nextgis/docs_ng.git
cd docs_ng
make html
make latexpdf

See wiki for future details

Update documentation

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

  • Clone or pull this repository (как правильно)
  • Wait buildbot task finished (check repository changes each 15 minutes)

Build status

build status

License

This documentaion is licensed under CC-BY-ND 3.0