Utilisation de flasksphinx
==========================

Installation
------------

l'installation du minimum

.. code-block:: bash

	apt-get install python-pip
	pip install flask
	pip flask-login
	pip flasksphinx
	ln -s  /usr/local/lib/python2.7/dist-packages/flasksphinx/themes/rtdflask /usr/local/lib/python2.7/dist-packages/sphinx/themes/rtdflask

on génère des dossiers pour notre application

.. code-block:: bash
	
	mkdir /var/www/mysite
	mkdir /var/www/mydoc
	cd /var/www/mydoc
	sphinx-quickstart

.. code-block:: bash
		
		Welcome to the Sphinx 1.3b1 quickstart utility.
		
		Please enter values for the following settings (just press Enter to
		accept a default value, if one is given in brackets).
		
		Enter the root path for documentation.
		> Root path for the documentation [.]: 
		
		You have two options for placing the build directory for Sphinx output.
		Either, you use a directory "_build" within the root path, or you separate
		"source" and "build" directories within the root path.
		> Separate source and build directories (y/n) [n]: y
		
		Inside the root directory, two more directories will be created; "_templates"
		for custom HTML templates and "_static" for custom stylesheets and other static
		files. You can enter another prefix (such as ".") to replace the underscore.
		> Name prefix for templates and static dir [_]: 
		
		The project name will occur in several places in the built documentation.
		> Project name: mydoc
		> Author name(s): Frédéric Aoustin
		
		Sphinx has the notion of a "version" and a "release" for the
		software. Each version can have multiple releases. For example, for
		Python the version is something like 2.5 or 3.0, while the release is
		something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
		just set both to the same value.
		> Project version: 1
		> Project release [1]: 0
		
		If the documents are to be written in a language other than English,
		you can select a language here by its language code. Sphinx will then
		translate text that it generates into that language.
		
		For a list of supported codes, see
		http://sphinx-doc.org/config.html#confval-language.
		> Project language [en]: fr
		
		The file name suffix for source files. Commonly, this is either ".txt"
		or ".rst".  Only files with this suffix are considered documents.
		> Source file suffix [.rst]: 
		
		One document is special in that it is considered the top node of the
		"contents tree", that is, it is the root of the hierarchical structure
		of the documents. Normally, this is "index", but if your "index"
		document is a custom template, you can also set this to another filename.
		> Name of your master document (without suffix) [index]: 
		
		Sphinx can also add configuration for epub output:
		> Do you want to use the epub builder (y/n) [n]: 
		
		Please indicate if you want to use one of the following Sphinx extensions:
		> autodoc: automatically insert docstrings from modules (y/n) [n]: 
		> doctest: automatically test code snippets in doctest blocks (y/n) [n]: 
		> intersphinx: link between Sphinx documentation of different projects (y/n) [n]: 
		> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: 
		> coverage: checks for documentation coverage (y/n) [n]: 
		> pngmath: include math, rendered as PNG images (y/n) [n]: 
		> mathjax: include math, rendered in the browser by MathJax (y/n) [n]: 
		> ifconfig: conditional inclusion of content based on config values (y/n) [n]: 
		> viewcode: include links to the source code of documented Python objects (y/n) [n]: 
		
		A Makefile and a Windows command file can be generated for you so that you
		only have to run e.g. `make html' instead of invoking sphinx-build
		directly.
		> Create Makefile? (y/n) [y]: 
		> Create Windows command file? (y/n) [y]: n
		
		Creating file ./source/conf.py.
		Creating file ./source/index.rst.
		Creating file ./Makefile.
		
		Finished: An initial directory structure has been created.
		
		You should now populate your master file ./source/index.rst and create other documentation
		source files. Use the Makefile to build the docs, like so:
		   make builder
		where "builder" is one of the supported builders, e.g. html, latex or linkcheck.cd 

.. code-block:: bash

	mkdir /var/www/mydoc/build
	mkdir /var/www/mydoc/source/data
	vi /var/www/mydoc/source/conf.py

.. code-block:: python

	extensions = ['sphinxcontrib.aafig','flasksphinx.todo']
	# html_theme = "default"
	html_theme = "rtdflask"

.. code-block:: bash

	chmod -r 777 /var/www/mydoc
	sphinx-build -b html /var/www/mydoc/source/ /var/www/mydoc/build/html/
	mkdir /var/www/mydoc/wsgi-scripts
	vi /var/www/mydoc/wsgi-scripts/myapp.wsgi

.. code-block:: python

    #!/usr/bin/env python
    # -*- coding: utf-8 -*-
    
    import sys
    import os, os.path
    import logging, logging.handlers
    
    from flask import Flask
    
    import flasksphinx
    
    app = Flask(__name__)
    app.config.from_pyfile(os.path.splitext(__file__)[0]+'.cfg')
    flasksphinx.init(app)
    
    
    #for mod wsgi
    application = app
        
    if __name__ == "__main__":
        handler = logging.StreamHandler()
        handler.setLevel(app.config['LEVEL'])
        app.logger.addHandler(handler)
        handler = logging.handlers.RotatingFileHandler(os.path.splitext(__file__)[0]+'.log', maxBytes=2000000, backupCount=5)
        handler.setLevel(app.config['LEVEL'])
        app.logger.addHandler(handler)
        app.run(host = app.config['HOST'], 
    		port = app.config['PORT'])


.. code-block:: bash

	chmod +x /var/www/mydoc/wsgi-scripts/myapp.wsgi
	vi /var/www/mydoc/wsgi-scripts/myapp.conf

.. code-block:: python

	#!/usr/bin/env python
	# -*- coding: utf-8 -*-
	
	import os
	import logging
	
	DEBUG = True
	SPHINX_BUILD_DIR = '/var/www/mydoc/build'
	SPHINX_CONF_DIR = '/var/www/mydoc/source'
	UPLOAD_FOLDER = '/var/www/mydoc/source/data'
	PORT = 5001
	HOST = '0.0.0.0'
	LEVEL = logging.DEBUG
	SECRET_KEY = 'secret_key'
	USERS = [
	         {  'id'       : 1,
	            'username' : 'admin',
	            'password' : 'keyadmin'
	         }
	        ]

En ajoutant l'extension flasksphinx.todo il est possible de faire des listes à cocher

.. code-block:: rst

    :x:`todo check`
    :o:`todo no check`


on peut aussi utiliser la directive todo

.. code-block:: rst

    .. todo:: mon action
        :start: 01/01/2015
        :end:   31/01/2015
        :time:  2j
        :checked:

        test todo
    

Utilisation StandAlone
----------------------

L'utilisation standAlone est assez simple

.. code-block:: bash

    cd /var/www/mydoc/wsgi-scripts/
    python myapp.wsgi

On a maintenant accès à notre application via http://localhost:5001/

Change Version
==============

0.0.6
-----

* correction current_user after break
* add favicon.ico in template login
* add directive todo

0.0.5
-----

* Add showLoading in savesphinx
* add role call, mail, warning, info, meeting
* manage template for new file

0.0.4
-----

* Add extension flasksphinx.todo