[PATCH 5 of 5 logilab-common V2] [doc] add instructions on how to build the doc

Laurent Peuch cortex at worlddomination.be
Wed Jun 19 20:09:59 CEST 2019


# HG changeset patch
# User Laurent Peuch <cortex at worlddomination.be>
# Date 1560966365 -7200
#      Wed Jun 19 19:46:05 2019 +0200
# Node ID 840624bd5b48e8aa24e2a131512ece8e57544b70
# Parent  a2b6bc127663fef394a7aa9eccc1ce7460ebe4ea
[doc] add instructions on how to build the doc

diff --git a/README b/README
--- a/README
+++ b/README
@@ -134,6 +134,29 @@ versions:
 * `sphinxutils`: we won't go that way imo (i == syt)
 
 
+Building the documentation
+--------------------------
+
+Create a virtualenv and install dependencies ::
+
+    virtualenv venv
+    source venv/bin/activate
+
+    # you need the krb5-config command to build all dependencies
+    # on debian you can get it using "apt-get install libkrb5-dev"
+
+    pip install doc/requirements-doc.txt
+
+    # install logilab-common
+    pip install -e .
+
+Then build the doc ::
+
+    cd doc
+    make html
+
+It's now available under `doc/_build/html/`
+
 Comments, support, bug reports
 ------------------------------
 



More information about the cubicweb-devel mailing list