readthedocs.io initial configuration

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = eden
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,170 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# eden documentation build configuration file, created by
+# sphinx-quickstart on Sat Jan 13 19:04:11 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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.
+#
+# import os
+# import sys
+# 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Sahana Eden'
+copyright = ''
+author = 'Eduardo Romero Palencia'
+
+# 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 = ''
+# The full version, including alpha/beta/rc tags.
+release = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'edendoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'eden.tex', 'eden Documentation',
+     'Eduardo Romero Palencia', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'eden', 'eden Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'eden', 'eden Documentation',
+     author, 'eden', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+

docs/index.rst

@@ -0,0 +1,15 @@
+.. eden documentation master file, created by
+   sphinx-quickstart on Sat Jan 13 19:04:11 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Sahana Eden Documentation Index
+========================
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Documentation
+
+   What is Sahana Eden?</pages/whatis>
+   Want to use Sahana Eden?</pages/wanttouse>

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=eden
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/pages/wanttouse.rst

@@ -0,0 +1,27 @@
+Want to Use Sahana Eden?
+===================
+Try out one of our Demos
+----------------
+- `Demo Site <http://demo.eden.sahanafoundation.org/>`_
+- `DRR Project <http://eden.sahanafoundation.org/wiki/InstallationGuidelines>`_
+
+Install the software on your own system:
+----------------
+- :doc:`./wanttouse/instalationguide`
+
+Read the Book
+----------------
+- :doc:`./wanttouse/book`
+
+Read the User Manual
+----------------
+- :doc:`./wanttouse/userguidelines`
+
+Join the Community
+----------------
+- :doc:`./wanttouse/mailinglist`
+- :doc:`./wanttouse/ircchat`
+
+If you’re using Sahana in your organization, please create a Deployment Page on the wiki to describe how you’ll be using Sahana and a BluePrint Page for any new features that you’d like to develop.
+
+The Sahana Eden team believe in Participatory Programming where the needs of you the users are paramount to what we build - we are here to listen to you & work with you to provide the best solution possible. Sahana extends the  Red Cross Code of Conduct in the way that we operate.

docs/pages/wanttouse/book.rst

@@ -0,0 +1,41 @@
+Book
+===================
+This book has been imagined to meet the need of three kinds of persons, decision makers looking for an appropriate solution for disaster management, those who are deploying Sahana Eden, and those who are extending Sahana Eden for more specialized solutions or want to contribute to the project.
+
+Online version
+----------------
+Note this is the most up-to-date version, as it is the source document.
+http://flossmanuals.net/sahana-eden/
+
+Downloadable versions
+----------------
+
+- `PDF <http://en.flossmanuals.net/_booki/sahana-eden/sahana-eden.pdf>`_
+- `EPub <http://en.flossmanuals.net/_booki/sahana-eden/sahana-eden.epub>`_
+
+Printed version
+----------------
+If you want to order a printed version of the book, you can do so at Lulu:
+http://www.lulu.com/shop/the-authors/sahana-eden/paperback/product-18745476.html
+
+Letting People Know About The Book
+----------------
+Link to this page for sharing:
+http://bit.ly/sahanaedenbook
+
+Sample QR code for including in printed materials:
+https://chart.googleapis.com/chart?chs=190x190&cht=qr&chl=http://bit.ly/sahanaedenbook
+
+Updates
+----------------
+The book is editable using  Booki. Note that whilst this is freely open, it should not be treated like a Wiki. The book content should be of a higher quality with complete sentences/paragraphs which flow smoothly as opposed to short notes or lists. Please do help by fixing any spelling/grammar errors in the book, improve the flow and add further clarification where needed. If you want to add new content, use the Wiki for rough notes & then draft new chapters in the 'Hold chapters' section. If you would like to change Sections or add a new Chapter please send an email to the sahana-eden mailing list so that this can be discussed in the community first. The 'Sahana Eden Book Editor' will review edits & push updates to both Floss Manuals & Lulu.
+
+To subscribe to see updated Chapters via RSS:
+http://booki.flossmanuals.net/feeds/rss/book/sahana-eden/
+
+Technical discussion of the Booki tool, as well as general dicussion on Open Publishing, should be done on the Floss Manuals mailing list:
+http://lists.flossmanuals.net/listinfo.cgi/discuss-flossmanuals.net
+
+History
+----------------
+The first version of this book was developed at the Google Doc Sprint 17-21 Oct.

docs/pages/wanttouse/instalationguide.rst

@@ -0,0 +1,20 @@
+Instalation Guidelines
+===================
+
+Sahana Eden can be installed on several different operating systems
+
+Operating Systems
+----------------
+- :doc:`./instalationguide/linux`
+- :doc:`./instalationguide/mac`
+- :doc:`./instalationguide/windows`
+
+Hosting
+----------------
+- :doc:`/instalationguide/amazon` (Recommended)
+- :doc:`/instalationguide/heroku`
+- :doc:`/instalationguide/openshift`
+- :doc:`/instalationguide/turnkey`
+- :doc:`/instalationguide/pythonanywhere`
+
+Hardware requirements are minimal - any modern server will be fine or if using a Virtual machine then a minimum of 1Gb RAM with 4Gb RAM recommended for larger deployments.