Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
superdmp committed Jun 23, 2011
1 parent 8fe0390 commit 9f8e86c
Show file tree
Hide file tree
Showing 13 changed files with 194 additions and 5 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/getting_started.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/installation.doctree
Binary file not shown.
15 changes: 15 additions & 0 deletions docs/_build/html/_sources/getting_started.txt
@@ -0,0 +1,15 @@
###############
Getting Started
###############

In order to make anything work, you'll need to do log in to Admin and do three things.

* create a Page
* create an Entity
* link the Entity to the Page, by selecting the Page as the Entity's /Home page/

And since Arkestra needs to know what the *base entity* of your site is, in your ``arkestra_settings`` file add something like::

ARKESTRA_BASE_ENTITY = 1

where the value corresponds to the id of your base entity.
2 changes: 2 additions & 0 deletions docs/_build/html/_sources/index.txt
Expand Up @@ -12,13 +12,15 @@ It is flexible, modular and extensible, and has a rich set of automated web publ

Arkestra was developed at `Cardiff University School of Medicine <http://medicine.cardiff.ac.uk/>`_ to provide a platform for the School’s web presence.

Arkestra can be obtained from our `GitHub repository <https://github.com/evildmp/Arkestra>`_.

Contents:

.. toctree::
:maxdepth: 2

installation
getting_started

Indices and tables
==================
Expand Down
17 changes: 16 additions & 1 deletion docs/_build/html/_sources/installation.txt
Expand Up @@ -6,14 +6,29 @@ Installation
Requirements
************

Django CMS
==========

Arkestra requires a working installation of `Django CMS <http://django-cms.org/>`_.

Django CMS has its own installation requirements; installing Django CMS will ensure that most of the components required by Arkestra are also installed.

You'll need to follow `Django CMS's installation instructions <https://www.django-cms.org/en/documentation/>`; do that first, before installing Arkestra.

Other components
================

In addition, Akestra requires installation of:

Available through pip
---------------------

* BeautifulSoup
* django-typogrify
* pyquery
* the Semantic Presentation Editor

Best currently installed from source
------------------------------------

* `the Semantic Presentation Editor <https://bitbucket.org/spookylukey/semanticeditor/>`_
* `Arkestra <https://github.com/evildmp/Arkestra/>`_
108 changes: 108 additions & 0 deletions docs/_build/html/getting_started.html
@@ -0,0 +1,108 @@


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Getting Started &mdash; Arkestra vdev documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: 'dev',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Arkestra vdev documentation" href="index.html" />
<link rel="prev" title="Installation" href="installation.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Arkestra vdev documentation</a> &raquo;</li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">

<div class="section" id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<p>In order to make anything work, you&#8217;ll need to do log in to Admin and do three things.</p>
<ul class="simple">
<li>create a Page</li>
<li>create an Entity</li>
<li>link the Entity to the Page, by selecting the Page as the Entity&#8217;s /Home page/</li>
</ul>
<p>And since Arkestra needs to know what the <em>base entity</em> of your site is, in your <tt class="docutils literal"><span class="pre">arkestra_settings</span></tt> file add something like:</p>
<p>ARKESTRA_BASE_ENTITY = 1</p>
<p>where the value corresponds to the id of your base entity.</p>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="installation.html"
title="previous chapter">Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/getting_started.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
>previous</a> |</li>
<li><a href="index.html">Arkestra vdev documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Daniele Procida.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
2 changes: 2 additions & 0 deletions docs/_build/html/index.html
Expand Up @@ -49,13 +49,15 @@ <h1>Welcome to Arkestra&#8217;s documentation!<a class="headerlink" href="#welco
<p>Arkestra is an intelligent, semantic web content management system for organisations and institutions.</p>
<p>It is flexible, modular and extensible, and has a rich set of automated web publishing tools.</p>
<p>Arkestra was developed at <a class="reference external" href="http://medicine.cardiff.ac.uk/">Cardiff University School of Medicine</a> to provide a platform for the School’s web presence.</p>
<p>Arkestra can be obtained from our <a class="reference external" href="https://github.com/evildmp/Arkestra">GitHub repository</a>.</p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#requirements">Requirements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
</ul>
</div>
</div>
Expand Down
50 changes: 47 additions & 3 deletions docs/_build/html/installation.html
Expand Up @@ -22,7 +22,9 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Arkestra vdev documentation" href="index.html" />
<link rel="top" title="Arkestra vdev documentation" href="index.html" />
<link rel="next" title="Getting Started" href="getting_started.html" />
<link rel="prev" title="Welcome to Arkestra’s documentation!" href="index.html" />
</head>
<body>
<div class="related">
Expand All @@ -31,6 +33,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="getting_started.html" title="Getting Started"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to Arkestra’s documentation!"
accesskey="P">previous</a> |</li>
<li><a href="index.html">Arkestra vdev documentation</a> &raquo;</li>
</ul>
</div>
Expand All @@ -44,16 +52,32 @@ <h3>Navigation</h3>
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
<div class="section" id="django-cms">
<h3>Django CMS<a class="headerlink" href="#django-cms" title="Permalink to this headline"></a></h3>
<p>Arkestra requires a working installation of <a class="reference external" href="http://django-cms.org/">Django CMS</a>.</p>
<p>Django CMS has its own installation requirements; installing Django CMS will ensure that most of the components required by Arkestra are also installed.</p>
<p>You&#8217;ll need to follow <cite>Django CMS&#8217;s installation instructions &lt;https://www.django-cms.org/en/documentation/&gt;</cite>; do that first, before installing Arkestra.</p>
</div>
<div class="section" id="other-components">
<h3>Other components<a class="headerlink" href="#other-components" title="Permalink to this headline"></a></h3>
<p>In addition, Akestra requires installation of:</p>
<div class="section" id="available-through-pip">
<h4>Available through pip<a class="headerlink" href="#available-through-pip" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li>BeautifulSoup</li>
<li>django-typogrify</li>
<li>pyquery</li>
<li>the Semantic Presentation Editor</li>
</ul>
</div>
<div class="section" id="best-currently-installed-from-source">
<h4>Best currently installed from source<a class="headerlink" href="#best-currently-installed-from-source" title="Permalink to this headline"></a></h4>
<ul class="simple">
<li><a class="reference external" href="https://bitbucket.org/spookylukey/semanticeditor/">the Semantic Presentation Editor</a></li>
<li><a class="reference external" href="https://github.com/evildmp/Arkestra/">Arkestra</a></li>
</ul>
</div>
</div>
</div>
</div>


Expand All @@ -65,11 +89,25 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Installation</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#requirements">Requirements</a><ul>
<li><a class="reference internal" href="#django-cms">Django CMS</a></li>
<li><a class="reference internal" href="#other-components">Other components</a><ul>
<li><a class="reference internal" href="#available-through-pip">Available through pip</a></li>
<li><a class="reference internal" href="#best-currently-installed-from-source">Best currently installed from source</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to Arkestra&#8217;s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="getting_started.html"
title="next chapter">Getting Started</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/installation.txt"
Expand Down Expand Up @@ -98,6 +136,12 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="getting_started.html" title="Getting Started"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to Arkestra’s documentation!"
>previous</a> |</li>
<li><a href="index.html">Arkestra vdev documentation</a> &raquo;</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -18,6 +18,7 @@ Contents:

.. toctree::
:maxdepth: 2

installation
getting_started

Expand Down
2 changes: 2 additions & 0 deletions docs/installation.rst
Expand Up @@ -23,6 +23,8 @@ In addition, Akestra requires installation of:
Available through pip
---------------------

(just use pip install <package_name>)

* BeautifulSoup
* django-typogrify
* pyquery
Expand Down

0 comments on commit 9f8e86c

Please sign in to comment.