06d51732e178

Mention how to preview.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 23 Jan 2012 20:05:49 -0500
parents b548eb6bb9a2
children 790fe5ece24e
branches/tags (none)
files docs/04-faqs.markdown

Changes

--- a/docs/04-faqs.markdown	Mon Jan 23 19:52:08 2012 -0500
+++ b/docs/04-faqs.markdown	Mon Jan 23 20:05:49 2012 -0500
@@ -103,6 +103,21 @@
 Writing Tools
 -------------
 
+### How can I preview the documentation locally?
+
+You need a real web server to preview the generated files effectively.  Luckily,
+you already have one: Python comes with a built-in server that's great for
+viewing local files.
+
+Build your docs, then in a separate terminal:
+
+    :::bash
+    cd myproject/docs
+    cd build
+    python -m SimpleHTTPServer
+
+Now open <http://localhost:8000> and view your docs!
+
 ### Can I make d auto-rerender when my files change?
 
 Yes, use [kicker](https://github.com/alloy/kicker) to watch for changes and run