Sphinx¶

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

mkdir /var/www/mysite
mkdir /var/www/mydoc
cd /var/www/mydoc
sphinx-quickstart

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

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

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

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

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

cp /etc/init.d/skeleton /etc/init.d/mydoc
chmod +x /etc/init.d/mydoc
vi /etc/init.d/mydoc

...
PATH=/sbin:/usr/sbin:/bin:/usr/bin
DESC="flasksphinx for mydoc"
NAME=myapp.wsgi
DAEMON=/var/www/mydoc/wsgi-scripts/$NAME
DAEMON_ARGS=""
PIDFILE=/var/run/$NAME.pid
SCRIPTNAME=/etc/init.d/$NAME
...
do_start()
{
     # Return
     #   0 if daemon has been started
     #   1 if daemon was already running
     #   2 if daemon could not be started
     start-stop-daemon --start --quiet --background --make-pidfile --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
         || return 1
     start-stop-daemon --start --quiet --background --make-pidfile --pidfile $PIDFILE --exec $DAEMON -- \
         $DAEMON_ARGS \
         || return 2
     # Add code here, if necessary, that waits for the process to be ready
     # to handle requests from services started subsequently which depend
     # on this one.  As a last resort, sleep for some time.
}
...
do_stop()
{
     # Return
     #   0 if daemon has been stopped
     #   1 if daemon was already stopped
     #   2 if daemon could not be stopped
     #   other if a failure occurred
     start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE
     RETVAL="$?"
     [ "$RETVAL" = 2 ] && return 2
     # Wait for children to finish too if this is a daemon that forks
     # and if the daemon is only ever run from this initscript.
     # If the above conditions are not satisfied then add some other code
     # that waits for the process to drop all resources that could be
     # needed by services started subsequently.  A last resort is to
     # sleep for some time.
     start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
     [ "$?" = 2 ] && return 2
     # Many daemons don't delete their pidfiles when they exit.
     rm -f $PIDFILE
     return "$RETVAL"
}
...

/etc/init.d/mydoc start

update-rc.d mydoc defaults 99

apt-get install apache2 libapache2-mod-wsgi python-dev
mkdir /var/www/mysite
cd /var/www/mysite
echo "<html>hello mysite</html>" > index.html

<VirtualHost *:80>
     ServerAdmin webmaster@localhost

     DocumentRoot /var/www/mysite
     <Directory />
         Options FollowSymLinks
         AllowOverride None
     </Directory>
     <Directory /var/www/mysite>
         Options Indexes FollowSymLinks MultiViews
         AllowOverride None
         Order allow,deny
         allow from all
     </Directory>

# permet d optimiser les performances
Alias /mydoc/_static /var/www/mydoc/build/html/_static
Alias /mydoc/_static /var/www/mydoc/build/html/_images
Alias /mydoc/_static /var/www/mydoc/build/html/_sources
Alias /mydoc/_static /var/www/mydoc/build/html/_download

     ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
     <Directory "/usr/lib/cgi-bin">
         AllowOverride None
         Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
         Order allow,deny
         Allow from all
     </Directory>

    # WSGIScriptAlias /myapp "/var/www/myapp/wsgi-scripts/myapp.wsgi"
    # <Directory "/var/www/myapp/wsgi-scripts">
    #    Order allow,deny
    #    Allow from all
    #</Directory>
    WSGIScriptAlias /mydoc "/var/www/mydoc/wsgi-scripts/myapp.wsgi"
    <Directory "/var/www/mydoc/wsgi-scripts">
        Order allow,deny
        Allow from all
    </Directory>

    ErrorLog ${APACHE_LOG_DIR}/error.log
    # Possible values include: debug, info, notice, warn, error, crit,
    # alert, emerg.
    LogLevel warn
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

/etc/init.d/apache2 restart

apt-get install apache2
cd /var/www/mysite
echo "<html>hello mysite</html>" > index.html

a2enmod proxy proxy_http
/etc/init.d/apache2 restart

<VirtualHost *:80>
     ServerAdmin webmaster@localhost

     DocumentRoot /var/www/mysite
     <Directory />
         Options FollowSymLinks
         AllowOverride None
     </Directory>
     <Directory /var/www/mysite>
         Options Indexes FollowSymLinks MultiViews
         AllowOverride None
         Order allow,deny
         allow from all
     </Directory>

 ProxyPass / http://localhost:5001/
 ProxyPassReverse / http://localhost:5001/
 ProxyPreserveHost On

    ErrorLog ${APACHE_LOG_DIR}/error.log
    # Possible values include: debug, info, notice, warn, error, crit,
    # alert, emerg.
    LogLevel warn
    CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

/etc/init.d/mydoc stop
/etc/init.d/apache2 stop
/etc/init.d/mydoc start
/etc/init.d/apache2 start