Permalink
Browse files

try to make it easier to use; move scripts to tools; add bootstrap.sh…

… which handles installing dependencies; update README
  • Loading branch information...
lazka committed Mar 8, 2014
1 parent 43c4f73 commit ed85922ec1b24f652a88eeca87ad1a65e67b2fa0
View
@@ -1,3 +1,4 @@
*.pyc
_docs
pgi
+_venv
View
@@ -20,21 +20,13 @@ Requirements
* Sphinx
* BeautifulSoup 3
+Calling ``source bootstrap.sh`` will put you in a virtualenv with all
+dependencies installed.
+
How do I get started?
---------------------
-::
-
- # API docs for Gtk:
- ./pgi-docgen.py <some_path> Gtk-3.0
-
- # Use sphinx to create the docs in <dest_path>
- ./pgi-docgen-build.py <dest_path> <some_path>
-
-
-or using the default output path ``./_docs``:
-
::
# API docs for Gtk/Gst:
@@ -47,8 +39,11 @@ or using the default output path ``./_docs``:
# Warning: This can take about an hour.
./build_all.sh
- # Force-pushes the result to my github.io repo, adjust the URL if needed
- ./push.sh
+ # To speed things up a bit set the JOBS env var.
+ # Only do this if you have enough RAM (~4 GB)
+ JOBS=4 ./build_all.sh
+
+The resulting docs can be found in ``_docs/_build``
License
View
@@ -0,0 +1,19 @@
+#/bin/bash
+
+# This sets up a virtual python environment and installs all dependencies
+# into "_venv". If this directory exists it will only start the virtual env.
+# Afterwards use build.sh for example
+
+echo "Usage: 'source bootstrap.sh'"
+
+VENV="_venv"
+
+if [ -d "$VENV" ]; then
+ . "$VENV"/bin/activate
+else
+ virtualenv _venv
+ . "$VENV"/bin/activate
+ pip install git+https://github.com/lazka/pgi.git
+ pip install sphinx
+ pip install BeautifulSoup
+fi
View
@@ -6,4 +6,4 @@ REM modify it under the terms of the GNU Lesser General Public
REM License as published by the Free Software Foundation; either
REM version 2.1 of the License, or (at your option) any later version.
-python pgi-docgen.py -f _docs %* && python pgi-docgen-build.py _docs/_build _docs
+python pgi-docgen.py -f _docs %* && python pgi-docgen-build.py _docs\_build _docs
View
@@ -6,4 +6,7 @@
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
-./pgi-docgen.py -f _docs "$@" && ./pgi-docgen-build.py _docs/_build _docs
+# Example usage: "./build.sh Atk-1.0"
+# Result can be found in "_docs/_build"
+
+python ./pgi-docgen.py -f _docs "$@" && ./pgi-docgen-build.py _docs/_build _docs
View
@@ -8,7 +8,10 @@
# this is the default build that gets published online
-./pgi-docgen.py -f _docs Atk-1.0 Cogl-1.0 CoglPango-1.0 DBus-1.0 \
+# Example usage: "./build_all.sh"
+# Result can be found in "_docs/_build"
+
+python ./pgi-docgen.py -f _docs Atk-1.0 Cogl-1.0 CoglPango-1.0 DBus-1.0 \
DBusGLib-1.0 Fcitx-1.0 GDesktopEnums-3.0 GIRepository-2.0 GL-1.0 GLib-2.0 \
GModule-2.0 GObject-2.0 Gdk-3.0 GdkPixbuf-2.0 GdkX11-3.0 Gio-2.0 \
Grl-0.2 GrlNet-0.2 Gst-1.0 GstAllocators-1.0 GstApp-1.0 GstAudio-1.0 \
@@ -40,4 +43,4 @@
SocialWebClient-0.25 SoupGNOME-2.4 SpiceClientGLib-2.0 GOffice-0.10 \
SpiceClientGtk-3.0 SugarGestures-1.0 TelepathyGLib-0.12 Wnck-3.0 \
TelepathyLogger-0.2 TotemPlParser-1.0 Xkl-1.0 Zpj-0.0 Zeitgeist-2.0 \
- && ./pgi-docgen-build.py _docs/_build _docs
+ && ./tools/pgi-docgen-build.py _docs/_build _docs
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -6,7 +6,7 @@
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
-# after ./default.sh, call this to force push the build to github pages
+# after ./build_all.sh, call this to force push the build to github pages
cd _docs/_build
rm -f README.rst

0 comments on commit ed85922

Please sign in to comment.