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    ```
  17    make doc
  18    INFO - Cleaning site directory
  19    INFO - Building documentation to directory: /home/vagrant/build/site-html
  20    ```
  21
  22    This runs `mkdocs build` plus extra transformion of some files and adds symlinks (see `CMakeLists.txt` for the exact steps).
  23
  24
  25 3. Start webserver for local testing
  26
  27    ```
  28    mkdocs serve
  29    [server:296] Serving on http://127.0.0.1:8000
  30    [handlers:62] Start watching changes
  31    ```
  32
  33    If you develop inside a Vagrant virtual machine:
  34    * add port forwarding to your Vagrantfile, e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000`
  35    * use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost
  36       IP does not get forwarded.