Commits

George Notaras  committed f37fce1

Added all documentation files

  • Participants
  • Parent commits 521bb13

Comments (0)

Files changed (6)

File docs/conf.py

 # serve to show the default.
 
 import sys, os
+sys.path.insert(0, os.path.abspath(os.path.join('..', 'src')))
+from thumbnail_works import get_version
 
 # 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
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+#templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
 # built documents.
 #
 # The short X.Y version.
-version = '0.1.0'
+version = get_version()
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = get_version()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 # 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.

File docs/configuration.rst

+
+=============
+Configuration
+=============
+
+This section contains information about how to configure your Django projects
+to use *django-thumbnail-works* and also contains a quick reference of the available
+*settings* that can be used in order to customize the functionality of this
+application.
+
+
+Configuring your project
+========================
+
+In the Django project's ``settings`` module, add ``thumbnail_works`` to the
+``INSTALLED_APPS`` setting::
+
+    INSTALLED_APPS = (
+        ...
+        'thumbnail_works',
+    )
+
+
+Reference of application settings
+=================================
+
+The following settings can be specified in the Django project's ``settings``
+module to customize the functionality of *django-thumbnail-works*.
+
+``SETTING_A``
+    Setting A ...
+
+
+Synchronize the project database
+================================
+
+Finally, synchronize the project's database using the following command::
+
+    python manage.py syncdb
+

File docs/index.rst

    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to django-thumbnail-works's documentation!
-====================================
+=========================
+django-thumbnail-works's documentation
+=========================
+
+Copyright 2010 `George Notaras`_ <gnot [at] g-loaded.eu>
+
+.. _`George Notaras`: http://www.g-loaded.eu/
+
+Welcome to the *django-thumbnail-works*'s documentation!
+
+
+About this project
+==================
+
+@DESCRIPTION@
+
+| **Author**: `@AUTHOR_NAME@ <http://www.g-loaded.eu/>`_
+| **Development Web Site**: `django-thumbnail-works project <https://www.codetrax.org/projects/django-thumbnail-works>`_
+| **Source Code Repository**: `django-thumbnail-works source code <https://source.codetrax.org/hgroot/django-thumbnail-works>`_
+
+
+About this guide
+================
+
+This guide provides an introduction to the *django-thumbnail-works* |version| release,
+including instructions about how to install, configure and use the current
+*django-thumbnail-works* in Django projects or individual applications.
+
+The contents of this documentation (the "*Documentation*") are subject to the
+**Apache License, Version 2.0** (the "*License*"); you may only use this
+Documentation if you comply with the terms of this License.
+
+A copy of the License exists in the product distribution; the *LICENSE* file.
+For copyright and other important notes regarding this release please read
+the *NOTICE* file.
+
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
+   
+   introduction
+   installation
+   configuration
+   usage
+
 
 Indices and tables
 ==================

File docs/installation.rst

+
+============
+Installation
+============
+
+This section contains information about how to download and install
+django-thumbnail-works in your system. It also contains brief instructions about how
+to build the included documentation.
+
+
+Requirements
+============
+
+This application requires Python_ 2.4 or later, and a functional installation
+of Django_.
+
+Detailed information about the minimum supported Django version and other
+Python modules that may be required in order to run this software is shown
+below:
+
+.. literalinclude:: ../requirements.txt
+
+This information exists in the ``requirements.txt`` file inside the
+django-thumbnail-works distribution package. If ``pip`` is used to install this software,
+then all these dependencies will also be installed.
+
+
+Download
+========
+
+You can download the latest django-thumbnail-works releases either from the
+`project page`_ at the *Python Package Index* (PyPI):
+
+.. _`project page`: http://pypi.python.org/pypi/django-thumbnail-works
+
+Or you can clone the project's public source code repository and then
+check-out any stable release, all of which are tagged::
+
+    hg clone https://source.codetrax.org/hgroot/django-thumbnail-works
+    hg tags
+    hg update 0.1.0
+
+
+Install
+=======
+
+To install django-thumbnail-works, use the provided installation script::
+
+    python setup.py install
+
+You can install ``django-thumbnail-works`` using ``pip``::
+
+    pip install django-thumbnail-works
+
+Or use ``easy_install``::
+
+    easy_install -Z django-thumbnail-works
+
+Note: the ``-Z`` flag is required to force ``easy_install`` to do a normal
+source install rather than a zipped egg; django-thumbnail-works cannot be
+used from a zipped egg install.
+
+Alternatively, you can simply place the ``thumbnail_works`` directory,
+which exists under the ``src`` directory, somewhere on your Python path,
+or symlink to it from somewhere on your Python path.
+
+Finally, it is also possible to install this application directly from
+the `source code repository`_ using ``pip``::
+
+    pip install -e hg+https://source.codetrax.org/hgroot/django-thumbnail-works#egg=django-thumbnail-works
+
+The above command will install the latest development release of
+django-thumbnail-works.
+
+To install a stable release directly from the `source code repository`_,
+for instance, the ``0.1.0`` release, run the following command::
+
+    pip install -e hg+https://source.codetrax.org/hgroot/django-thumbnail-works@0.1.0#egg=django-thumbnail-works-0.1.0
+
+Please note that the mercurial_ source control management tool is required
+for this operation.
+
+.. _mercurial: http://mercurial.selenic.com/
+.. _`source code repository`: hg+https://source.codetrax.org/hgroot/django-thumbnail-works
+
+
+How to build the documentation
+==============================
+
+This project's documentation is located in source form under the ``docs``
+directory. In order to convert the documentation to a format that is
+easy to read and navigate you need the ``sphinx`` package.
+
+You can install ``sphinx`` using ``pip``::
+
+    pip install sphinx
+
+Or ``easy_install``::
+
+    easy_install sphinx
+
+Once ``sphinx`` is installed, change to the ``docs`` directory, open a shell
+and run the following command::
+
+    make html
+
+This will build a HTML version of the documentation. You can read the
+documentation by opening the following file in any web browser::
+
+    docs/_build/html/index.html
+

File docs/introduction.rst

+
+============
+Introduction
+============
+
+This section contains an introduction to *django-thumbnail-works*, including general
+information about submitting bug reports and making feature requests and
+may also outline the ways to get support for this application.
+
+@DESCRIPTION@
+
+Licensed under the **Apache License version 2.0**. More licensing information
+exists in the license_ section.
+
+Features
+========
+
+- Feature A
+- Feature B
+
+
+Documentation
+=============
+More information about the installation, configuration and usage of this app
+can be found in the `django-thumbnail-works Online Documentation`_
+or at the project's wiki_.
+
+.. _`online documentation`: http://packages.python.org/django-thumbnail-works
+.. _wiki: http://www.codetrax.org/projects/django-thumbnail-works/wiki
+
+
+Bugs and feature requests
+=========================
+In case you run into any problems while using this application or think that
+a new feature should be implemented, it is highly recommended you submit_ a new
+report about it at the project's `issue tracker`_.
+
+Using the *issue tracker* is the recommended way to notify the authors about
+bugs or make feature requests. Also, before submitting a new report, please
+make sure you have read the `new issue guidelines`_.
+
+.. _submit: http://www.codetrax.org/projects/django-thumbnail-works/issues/new
+.. _`issue tracker`: http://www.codetrax.org/projects/django-thumbnail-works/issues
+.. _`new issue guidelines`: http://www.codetrax.org/NewIssueGuidelines
+
+
+Support
+=======
+CodeTRAX does not provide support for django-thumbnail-works.
+
+You can still get community support at the `Community Support Forums`__:
+
+.. __: http://www.codetrax.org/projects/django-thumbnail-works/boards
+
+    
+License
+=======
+Copyright 2010 George Notaras <gnot [at] g-loaded.eu>
+
+Licensed under the **Apache License, Version 2.0** (the "*License*");
+you may not use this file except in compliance with the License.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+A copy of the License exists in the product distribution; the *LICENSE* file.
+For copyright and other important notes regarding this release please read
+the *NOTICE* file.
+
+

File docs/usage.rst

+
+=====
+Usage
+=====
+
+This section contains information, including examples, about how to use
+*django-thumbnail-works* in your existing Django projects or applications.
+