Travis: documentation suggests we need to add postgresql-client package pre-startup

[nominatim.git] / docs / develop / Documentation.md

diff --git a/docs/develop/Documentation.md b/docs/develop/Documentation.md
index eb3c99d8578df5243100775146a6ff6ccc13cb6e..df8d2b1a84f05a8dab945f3b100d9935deea5b1a 100644 (file)
--- a/docs/develop/Documentation.md
+++ b/docs/develop/Documentation.md
@@ -1,32 +1,36 @@
 # Documentation Pages
 
 # Documentation Pages
 

-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/]()
+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/](https://nominatim.org/release-docs/develop/)

 
 

-To preview local changes:
+To preview local changes, first install MkDocs

 
 

-1. Install MkDocs
+```
+pip3 install --user mkdocs
+```

 
 

-    ```
-    pip3 install --user mkdocs 
-    ```

 
 

+Then go to the build directory and run

 
 

-2. In build directory run
+```
+make doc
+INFO - Cleaning site directory
+INFO - Building documentation to directory: /home/vagrant/build/site-html
+```

 
 

-        make doc
-        INFO - Cleaning site directory
-        INFO - Building documentation to directory: /home/vagrant/build/site-html 
+This runs `mkdocs build` plus extra transformation of some files and adds
+symlinks (see `CMakeLists.txt` for the exact steps).

 
 

-    This runs `mkdocs build` plus extra transformion of some files and adds symlinks (see `CMakeLists.txt` for the exact steps).
+Now you can start webserver for local testing

 
 

+```
+build> mkdocs serve
+[server:296] Serving on http://127.0.0.1:8000
+[handlers:62] Start watching changes
+```

 
 

-3. Start webserver for local testing
+If you develop inside a Vagrant virtual machine:

 
 

-        mkdocs serve
-        [server:296] Serving on http://127.0.0.1:8000
-        [handlers:62] Start watching changes
-
-    If you develop inside a Vagrant virtual machine:
-    * add port forwarding to your Vagrantfile, e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000`
-    * use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost
-       IP does not get forwarded.
+ * add port forwarding to your Vagrantfile,
+   e.g. `config.vm.network "forwarded_port", guest: 8000, host: 8000`
+ * use `mkdocs serve --dev-addr 0.0.0.0:8000` because the default localhost
+   IP does not get forwarded.