Commits

Mikhail Korobov  committed 5c56c1f

Docs markup is improved

  • Participants
  • Parent commits bb24795

Comments (0)

Files changed (5)

 docs/_build
 .build/
 MANIFEST
+django_fab_deploy.egg-info/

File docs/fabfile.rst

 
 * Write a function populating :attr:`env` and :attr:`env.conf` for each server
   configuration.
-* Call :func:`update_env` at the end of each function.
+* Call :func:`update_env() <fab_deploy.utils.update_env>` at the end of
+  each function.
 * In order to specify configuration the fab commands should use, run the
   configuring function as a first fab command::
 

File docs/guide.rst

 
         my_site()
 
-   In order to make things simple set ``env.user`` to your project name. It
+   In order to make things simple set :attr:`env.user` to your project name. It
    should be a valid python identifier. Don't worry if there is no such user
    on server, django-fab-deploy can create linux user and setup ssh
    access for you, and it is preferrable to have linux user per
 
    .. note::
 
-       There are some defaults, e.g. ``DB_NAME`` equals to ``INSTANCE_NAME``,
-       and ``INSTANCE_NAME`` equals to ``env.user``.
+       There are some defaults, e.g. :attr:`DB_NAME <env.conf.DB_NAME>`
+       equals to :attr:`INSTANCE_NAME <env.conf.INSTANCE_NAME>`,
+       and :attr:`INSTANCE_NAME <env.conf.INSTANCE_NAME>` equals
+       to :attr:`env.user`.
 
        Read :doc:`fabfile` for more details.
 
    .. note::
 
        {{ variables }} can be used in config templates (engine is jinja2).
-       They will be replaced with values from ``env.conf`` on server.
+       They will be replaced with values from :attr:`env.conf` on server.
 
-       If you change web server config file or ``env.conf`` variables
+       If you change web server config file or :attr:`env.conf` variables
        after initial deployment, apply the changes in web server configs
        by running ::
 
    .. note::
 
        {{ variables }} can be used in :file:`config.server.py`. They will be
-       replaced with values from ``env.conf`` on server.
+       replaced with values from :attr:`env.conf` on server.
 
-       If you change :file:`config.server.py` or ``env.conf`` variables
+       If you change :file:`config.server.py` or :attr:`env.conf` variables
        after initial deployment, apply the changes to :file:`config.server.py`
        by running ::
 

File docs/reference.rst

     django-fab-deploy is still at early stages of development and API may
     change in future.
 
-
 Django
 ------
 

File fab_deploy/deploy.py

     """ Sets up a web server (apache + nginx). """
     apache_install()
     nginx_install()
+
     apache_setup()
     nginx_setup()