浏览代码

Explain how to view docs

JC Brand 6 年之前
父节点
当前提交
ac79a0d169
共有 1 个文件被更改,包括 8 次插入0 次删除
  1. 8 0
      docs/source/documentation.rst

+ 8 - 0
docs/source/documentation.rst

@@ -58,3 +58,11 @@ running::
 The HTMl files will be located in ``./docs/html``
 
 .. warning:: When contributing, please don't commit any generated html files.
+
+Serving the documentation
+-------------------------
+
+To view the generated docs, you can run ``make serve`` and then open
+http://localhost:8000/docs/html/index.html in your browser.
+
+