Skip to content

Commit

Permalink
Created sphinx docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dohomi committed Oct 25, 2014
1 parent 2f7248b commit fbdc4e2
Show file tree
Hide file tree
Showing 36 changed files with 469 additions and 277 deletions.
Empty file modified Changelog.md
100644 → 100755
Empty file.
1 change: 1 addition & 0 deletions Documentation/AdministratorManual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Configuration
Constants configuration of the plugin

Here you can change the default behaviour of all included galleries

FAQ
====

Expand Down
5 changes: 4 additions & 1 deletion Documentation/DeveloperCorner.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Target group: **Developers**
I do accept any participants for this project. Pull requests are more than welcome at the `git`_ repository

.. _git: https://github.com/dohomi/flux_galleria

Hooks
=======

Expand All @@ -15,4 +16,6 @@ There are currently no hooks available
API
=======

The project is based on the extension `flux`_. All the flexform structure and plugin registration is done through the flux API. Hopefully you won't bump into any issues through this dependency.
The project is based on the extension `flux`_. All the flexform structure and plugin registration is done through the flux API. Hopefully you won't bump into any issues through this dependency.

.. _flux: http://typo3.org/extensions/repository/view/flux
Empty file modified Documentation/Images/AdministratorManual/Installation_1.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified Documentation/Images/Flexform_Example.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified Documentation/Images/Galleria.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified Documentation/Images/Typoscript_Example.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified Documentation/Images/UserManual/Choose_Element.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified Documentation/Images/UserManual/Galleria_Backend.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* optional: soft carriage return preferred.
.. Includes roles, substitutions, ...
.. include:: _IncludedDirectives.rst
=================
Extension Name
Expand Down Expand Up @@ -35,13 +34,6 @@ The content of this document is related to TYPO3, a GNU/GPL CMS/Framework availa
TyposcriptReference
DeveloperCorner

.. STILL TO ADD IN THIS DOCUMENT
@todo: add section about how screenshots can be automated. Pointer to PhantomJS could be added.
@todo: explain how documentation can be rendered locally and remotely.
@todo: explain what files should be versionned and what not (_build, Makefile, conf.py, ...)
.. include:: ../Readme.rst

What does it do?
=================

Expand Down
2 changes: 1 addition & 1 deletion Documentation/ProjectInformation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Bugs and Known Issues

Please make use of the github `Issue Tracker`_ to report any bugs and issues.

.. _Bug Tracker: https://github.com/dohomi/flux_galleria/issues
.. _Issue Tracker: https://github.com/dohomi/flux_galleria/issues

To Do
-----------
Expand Down
237 changes: 0 additions & 237 deletions Documentation/RestructuredtextHelp.rst

This file was deleted.

21 changes: 0 additions & 21 deletions Documentation/_IncludedDirectives.rst

This file was deleted.

Loading

0 comments on commit fbdc4e2

Please sign in to comment.