docs/develop/Documentation.md

   1 # Documentation Pages
   2
   3 The [Nominatim documentation](https://nominatim.org/release-docs/develop/) is built using the [MkDocs](https://www.mkdocs.org/) static site generation framework. The master branch is automatically deployed every night on under [https://nominatim.org/release-docs/develop/]()
   4
   5 To preview local changes:
   6
   7 1. Install MkDocs
   8
   9     ```
  10     pip3 install --user mkdocs
  11     ```
  12
  13
  14 2. In build directory run
  15
  16         make doc
  17         INFO - Cleaning site directory
  18         INFO - Building documentation to directory: /home/vagrant/build/site-html
  19
  20     This runs `mkdocs build` plus extra transformion of some files and adds symlinks (see `CMakeLists.txt` for the exact steps).
  21
  22
  23 3. Start webserver for local testing
  24
  25         mkdocs serve
  26         [server:296] Serving on http://127.0.0.1:8000
  27         [handlers:62] Start watching changes
  28
  29     If you develop inside a Vagrant virtual machine:
  30     * add port forwarding to your Vagrantfile, e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000`
  31     * use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost
  32        IP does not get forwarded.