Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

typo & README for docs #3

Open
wants to merge 3 commits into from

1 participant

@gr2m

It might be obvious for Python developers how to build the docs, but it got be puzzled for a bit so I added a tiny README in the /docs folder on how to build the docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 27, 2013
  1. @gr2m

    typo

    gr2m authored
  2. @gr2m

    added info on how to build docs

    gr2m authored
  3. @gr2m
This page is out of date. Refresh to see the latest.
Showing with 12 additions and 1 deletion.
  1. +11 −0 docs/README.md
  2. +1 −1  docs/dev/source/static_pages.rst
11 docs/README.md
@@ -0,0 +1,11 @@
+Build docs
+============
+
+The docs in /docs/dev and /docs/user can be build using [sphinx](http://sphinx-doc.org/). Install with:
+
+```
+$ easy_install sphinx
+```
+
+To generate the respective dev & user docs, run `make` and follow
+the instructions in `docs/dev` and `docs/user/de`.
View
2  docs/dev/source/static_pages.rst
@@ -1,7 +1,7 @@
Static pages
============
-GBI-Server is not a CMS, but you can add contant as static files (e.g. for terms of use, etc).
+GBI-Server is not a CMS, but you can add content as static files (e.g. for terms of use, etc).
You need to configure ``STATIC_PAGES_DIR`` to point to a directory with HTML files.
The URL ``/page/<lang>/<name>`` will return the file ``STATIC_PAGES_DIR/<lang>/<name>``.
Something went wrong with that request. Please try again.