diff options
| author | Laurent Peuch <cortex@worlddomination.be> | 2019-06-19 19:46:05 +0200 |
|---|---|---|
| committer | Laurent Peuch <cortex@worlddomination.be> | 2019-06-19 19:46:05 +0200 |
| commit | a3fa0a553f560b6c4396a7e806707ddd0cddcdf8 (patch) | |
| tree | 16d4f6ff5bdbfbb5c52900ee6a86492158634779 | |
| parent | b0d82c89ebbf9e779804bf34c2abbffd789abd94 (diff) | |
| download | logilab-common-a3fa0a553f560b6c4396a7e806707ddd0cddcdf8.tar.gz | |
[doc] add instructions on how to build the doc
| -rw-r--r-- | README | 23 |
1 files changed, 23 insertions, 0 deletions
@@ -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 ------------------------------ |