Permalink
Browse files

New version of the docs

  • Loading branch information...
ingenieroariel committed Oct 18, 2011
1 parent 51ed575 commit 21fdae9c7fb23dfcfdaeff733a364b61352a794d
Showing with 2,471 additions and 1,210 deletions.
  1. +57 −16 docs/Makefile
  2. +88 −26 docs/{source → }/conf.py
  3. +50 −0 docs/deploy/customize.txt
  4. +36 −0 docs/deploy/debug.txt
  5. BIN docs/{source/deploy → deploy/images}/GeoServer-JAI-Settings.png
  6. BIN docs/{source/deploy → deploy/images}/GeoServer-Web-Map-Service.png
  7. +176 −2 docs/{source/deploy/tarball.rst → deploy/install.txt}
  8. +136 −23 docs/{source/deploy/production.rst → deploy/production.txt}
  9. +294 −0 docs/developers/architecture.txt
  10. +52 −0 docs/developers/contribute.txt
  11. +210 −0 docs/developers/extend.txt
  12. +78 −0 docs/developers/gnips.txt
  13. +57 −0 docs/developers/patches.txt
  14. +80 −0 docs/{source/django-apps/maps.rst → developers/reference/django-apps.txt}
  15. +1 −41 docs/{source/geoserver-extensions.rst → developers/reference/geoserver.txt}
  16. +12 −0 docs/developers/reference/index.txt
  17. +1 −0 docs/{source/geonode-javascript.rst → developers/reference/javascript.txt}
  18. +47 −0 docs/developers/roadmap.txt
  19. +228 −0 docs/developers/setup.txt
  20. +65 −42 docs/{source/developers/integration-testing.rst → developers/tests.txt}
  21. +85 −0 docs/index.txt
  22. +53 −0 docs/intro/install.txt
  23. +61 −0 docs/intro/overview.txt
  24. +72 −15 docs/make.bat
  25. +0 −11 docs/source/about-geonode.rst
  26. +0 −417 docs/source/deploy/centos.rst
  27. +0 −39 docs/source/deploy/ubuntu.rst
  28. +0 −218 docs/source/deployment.rst
  29. +0 −26 docs/source/django-apps.rst
  30. +0 −28 docs/source/django-apps/core.rst
  31. +0 −20 docs/source/django-apps/proxy.rst
  32. +0 −6 docs/source/geonetwork-extensions.rst
  33. +0 −194 docs/source/getting-started.rst
  34. +0 −32 docs/source/index.rst
  35. +0 −54 docs/source/logging.rst
  36. +89 −0 docs/users/create.txt
  37. +103 −0 docs/users/explore.txt
  38. BIN docs/users/images/activation_email.png
  39. BIN docs/users/images/activation_sent.png
  40. BIN docs/users/images/logged_in.png
  41. BIN docs/users/images/login_form.png
  42. BIN docs/users/images/login_register.png
  43. BIN docs/users/images/register_form.png
  44. +32 −0 docs/users/index.txt
  45. +55 −0 docs/users/register.txt
  46. +95 −0 docs/users/share.txt
  47. +158 −0 docs/users/upload.txt
View
@@ -10,22 +10,28 @@ BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
- @echo " html to make standalone HTML files"
- @echo " dirhtml to make HTML files named index.html in directories"
- @echo " pickle to make pickle files"
- @echo " json to make JSON files"
- @echo " htmlhelp to make HTML files and a HTML help project"
- @echo " qthelp to make HTML files and a qthelp project"
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
- @echo " changes to make an overview of all changed/added/deprecated items"
- @echo " linkcheck to check all external links for integrity"
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
@@ -40,6 +46,11 @@ dirhtml:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@@ -61,16 +72,46 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GeoNodeDeveloperDocumentation.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/GeoNode.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GeoNodeDeveloperDocumentation.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GeoNode.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/GeoNode"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GeoNode"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
- @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
- "run these through (pdf)latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
#
-# GeoNode Developer Documentation documentation build configuration file, created by
-# sphinx-quickstart on Wed May 12 15:50:17 2010.
+# GeoNode documentation build configuration file, created by
+# sphinx-quickstart on Mon Oct 3 16:20:38 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
@@ -16,10 +16,13 @@
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.append(os.path.abspath('.'))
+#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
@@ -28,26 +31,26 @@
templates_path = ['_templates']
# The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = '.txt'
# The encoding of source files.
-#source_encoding = 'utf-8'
+#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
-project = u'GeoNode Developer Documentation'
-copyright = u'2010, David Winslow'
+project = u'GeoNode'
+copyright = u'2011, GeoNode development team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.1'
+version = '1.1'
# The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = '1.1RC2'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -59,12 +62,9 @@
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directory, that shouldn't be searched
-# for source files.
-exclude_trees = []
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -89,9 +89,9 @@
# -- Options for HTML output ---------------------------------------------------
-# The theme to use for HTML and HTML Help pages. Major themes that come with
-# Sphinx are currently 'default' and 'sphinxdoc'.
-# html_theme = 'default'
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -120,7 +120,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
@@ -138,7 +138,7 @@
#html_additional_pages = {}
# If false, no module index is generated.
-#html_use_modindex = True
+#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
@@ -149,16 +149,22 @@
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'GeoNodeDeveloperDocumentationdoc'
+htmlhelp_basename = 'GeoNodedoc'
# -- Options for LaTeX output --------------------------------------------------
@@ -172,8 +178,8 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'GeoNodeDeveloperDocumentation.tex', u'GeoNode Developer Documentation Documentation',
- u'David Winslow', 'manual'),
+ ('index', 'GeoNode.tex', u'GeoNode Documentation',
+ u'GeoNode development team', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@@ -184,11 +190,67 @@
# not chapters.
#latex_use_parts = False
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
-#latex_use_modindex = True
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'geonode', u'GeoNode Documentation',
+ [u'GeoNode development team'], 1)
+]
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'GeoNode'
+epub_author = u'GeoNode development team'
+epub_publisher = u'GeoNode development team'
+epub_copyright = u'2011, GeoNode development team'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
View
@@ -0,0 +1,50 @@
+========================================
+Customizing the look and feel of GeoNode
+========================================
+
+This section will explain how to change GeoNode's main logo, the index page and the colors.
+It also contains an introduction to Django's template and media management.
+
+The paths to the different locations are assumed to be on Ubuntu with GeoNode installed via packages, but the same notions can be applied in any deployment.
+
+Customizing the home page
+=========================
+
+GeoNode uses Django's template engine, :file:`/etc/geonode/templates` is empty by default but it is abover other folders in the template lookup hierarchy.
+This means that it is possible to copy any html template to that location and it will take precence.
+Let's start by doing the following::
+
+ sudo cp /var/lib/geonode/src/GeoNodePy/geonode/templates/index.html /etc/geonode/templates
+
+The copy of :file:`index.html` that was just created takes precedence over the default one, the text in the main section can be changed there and a reload of the web page in the browser will show the updated version.
+
+.. note:: Changes to templates are picked up automatically and do not require a server restart.
+
+With the same approach, the structure of all pages can be modified by copying and then editing ``page_template.html``. We recommend reading about the `Django template language`_ for advanced customizations.
+
+.. _ Django template language: http://docs.djangoproject.com/
+
+.. note:: While editing the templates in place will also achieve the expected results, it will make upgrading GeoNode harder, therefore it is recommended to follow the approach described above.
+
+
+Changing the default logo
+=========================
+
+Similarly to the way the templates work, GeoNode's images and css files can be overriden in :file:`/etc/geonode/media`.
+
+The original GeoNode logo is located at :file:`/var/lib/geonode/src/GeoNode/geonode/media/theme/img/logo-bg.png`.
+Make a copy and edit it using Photoshop, GIMP, or your preferred image editor and then save it in :file:`/etc/geonode/media/theme/img/logo-bg.png`.
+
+Once the logo is placed there, it is neccessary to run the media collection command::
+
+ sudo geonode collectstatic -v0
+
+This will gather all the media in the diferent locations (both source and the user customizations) and put it in the directory being served by apache: :file:`/var/www/geonode/static/`.
+
+.. note:: It is not recommended to change the files directly in :file:`/var/www/geonode/static/` because they are overwritten any time the media collaction command is run.
+
+
+Changing the entire site media
+==============================
+
+All the files in :file:`/var/lib/geonode/src/GeoNodePy/geonode/media/theme` can be overriden using this method, including :file:`css/base.css` which contains most of the color schemes for the entire site.
Oops, something went wrong.

0 comments on commit 21fdae9

Please sign in to comment.