Mercurial > kallithea

changeset 5433:fbbe80e3322b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: consistent spacing around headings Start out with 2 empty lines before/after for top level, decrease for deeper levels.
author Mads Kiilerich <madski@unity3d.com>
date Wed, 26 Aug 2015 17:28:58 +0200
parents a4c0fe15a6f1
children 8867673c8192
files README.rst docs/api/api.rst docs/changelog.rst docs/contributing.rst docs/index.rst docs/installation.rst docs/installation_iis.rst docs/installation_win.rst docs/installation_win_old.rst docs/overview.rst docs/setup.rst docs/usage/backup.rst docs/usage/debugging.rst docs/usage/email.rst docs/usage/general.rst docs/usage/performance.rst docs/usage/vcs_support.rst kallithea/i18n/how_to
diffstat 18 files changed, 38 insertions(+), 51 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/README.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -2,6 +2,7 @@
 Kallithea README
 ================
 
+
 About
 -----
 
@@ -24,6 +25,7 @@
 
 Installation
 ------------
+
 Kallithea requires Python_ 2.x and it is recommended to install it in a
 virtualenv_. Official releases of Kallithea can be installed with::
 
--- a/docs/api/api.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/api/api.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -4,7 +4,6 @@
 API
 ===
 
-
 Kallithea has a simple JSON RPC API with a single schema for calling all API
 methods. Everything is available by sending JSON encoded http(s) requests to
 ``<your_server>/_admin/api``.
@@ -137,7 +136,6 @@
     result : "Pulled from `<reponame>`"
     error :  null
 
-
 rescan_repos
 ------------
 
@@ -161,7 +159,6 @@
                'removed': [<list of names of removed repos>]}"
     error :  null
 
-
 invalidate_cache
 ----------------
 
@@ -184,7 +181,6 @@
     result : "Caches of repository `<reponame>`"
     error :  null
 
-
 lock
 ----
 
@@ -216,7 +212,6 @@
              }
     error :  null
 
-
 get_ip
 ------
 
@@ -249,7 +244,6 @@
 
     error :  null
 
-
 get_user
 --------
 
@@ -295,7 +289,6 @@
             }
     error:  null
 
-
 get_users
 ---------
 
@@ -382,7 +375,6 @@
 
     kallithea-api create_user username:bent email:bent@example.com firstname:Bent lastname:Bentsen extern_type:ldap extern_name:uid=bent,dc=example,dc=com
 
-
 update_user
 -----------
 
@@ -428,7 +420,6 @@
             }
     error:  null
 
-
 delete_user
 -----------
 
@@ -454,7 +445,6 @@
             }
     error:  null
 
-
 get_user_group
 --------------
 
@@ -498,7 +488,6 @@
              }
     error : null
 
-
 get_user_groups
 ---------------
 
@@ -526,7 +515,6 @@
               ]
     error : null
 
-
 create_user_group
 -----------------
 
@@ -558,7 +546,6 @@
             }
     error:  null
 
-
 add_user_to_user_group
 ----------------------
 
@@ -587,7 +574,6 @@
             }
     error:  null
 
-
 remove_user_from_user_group
 ---------------------------
 
@@ -616,7 +602,6 @@
             }
     error:  null
 
-
 get_repo
 --------
 
@@ -706,7 +691,6 @@
             }
     error:  null
 
-
 get_repos
 ---------
 
@@ -745,7 +729,6 @@
             ]
     error:  null
 
-
 get_repo_nodes
 --------------
 
@@ -778,7 +761,6 @@
             ]
     error:  null
 
-
 create_repo
 -----------
 
@@ -832,7 +814,6 @@
             }
     error:  null
 
-
 update_repo
 -----------
 
@@ -894,7 +875,6 @@
             }
     error:  null
 
-
 fork_repo
 ---------
 
@@ -932,7 +912,6 @@
             }
     error:  null
 
-
 delete_repo
 -----------
 
@@ -961,7 +940,6 @@
             }
     error:  null
 
-
 grant_user_permission
 ---------------------
 
@@ -989,7 +967,6 @@
             }
     error:  null
 
-
 revoke_user_permission
 ----------------------
 
@@ -1016,7 +993,6 @@
             }
     error:  null
 
-
 grant_user_group_permission
 ---------------------------
 
@@ -1045,7 +1021,6 @@
             }
     error:  null
 
-
 revoke_user_group_permission
 ----------------------------
 
--- a/docs/changelog.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/changelog.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -6,4 +6,5 @@
 
 Kallithea project doesn't keep its changelog here.  We refer you to our `Mercurial logs`__.
 
+
 .. __: https://kallithea-scm.org/repos/kallithea/changelog
--- a/docs/contributing.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/contributing.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -24,6 +24,7 @@
 To register, you can use your Bitbucket or GitHub account. See :ref:`translations`
 for more details.
 
+
 Getting started
 ---------------
 
@@ -69,6 +70,7 @@
                           printed immediately) [NOSE_NOCAPTURE]
     --failed              Run the tests that failed in the last test run.
 
+
 Coding/contribution guidelines
 ------------------------------
 
@@ -134,6 +136,7 @@
 .. _translations:
 .. include:: ./../kallithea/i18n/how_to
 
+
 "Roadmap"
 ---------
 
--- a/docs/index.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/index.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -4,7 +4,6 @@
 Kallithea Documentation
 #######################
 
-
 **Readme**
 
 .. toctree::
@@ -68,6 +67,7 @@
 * :ref:`genindex`
 * :ref:`search`
 
+
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
--- a/docs/installation.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/installation.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -28,6 +28,7 @@
 
 .. _installation-source:
 
+
 Installation from repository source
 -----------------------------------
 
@@ -48,6 +49,7 @@
 
 .. _installation-virtualenv:
 
+
 Installing a released version in a virtualenv
 ---------------------------------------------
 
@@ -91,6 +93,7 @@
 
 .. _installation-without-virtualenv:
 
+
 Installing a released version without virtualenv
 ------------------------------------------------
 
@@ -107,6 +110,7 @@
 
 You can now proceed to :ref:`setup`.
 
+
 Upgrading Kallithea from Python Package Index (PyPI)
 ----------------------------------------------------
 
--- a/docs/installation_iis.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/installation_iis.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -12,12 +12,14 @@
     For the best security, it is strongly recommended to only host the site over
     a secure connection, e.g. using TLS.
 
+
 Prerequisites
 -------------
 
 Apart from the normal requirements for Kallithea, it is also necessary to get an
 ISAPI-WSGI bridge module, e.g. isapi-wsgi.
 
+
 Installation
 ------------
 
@@ -41,7 +43,6 @@
     The application pool can be the same as an existing application pool,
     as long as the Kallithea requirements are met by the existing pool.
 
-
 ISAPI handler
 .............
 
@@ -89,6 +90,7 @@
 The last necessary step is to enable the relevant authentication in IIS, e.g.
 Windows authentication.
 
+
 Troubleshooting
 ---------------
 
--- a/docs/installation_win.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/installation_win.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -4,6 +4,7 @@
 Installation and upgrade on Windows (7/Server 2008 R2 and newer)
 ================================================================
 
+
 First time install
 ::::::::::::::::::
 
@@ -13,7 +14,6 @@
 
 To install on an older version of Windows, see `<installation_win_old.html>`_
 
-
 Step 1 - Install Python
 -----------------------
 
@@ -30,7 +30,6 @@
 Remember the specific major and minor versions installed, because they will
 be needed in the next step. In this case, it is "2.7".
 
-
 Step 2 - Python BIN
 -------------------
 
@@ -45,7 +44,6 @@
 Please substitute [your-python-path] with your Python installation
 path. Typically this is ``C:\\Python27``.
 
-
 Step 3 - Install pywin32 extensions
 -----------------------------------
 
@@ -62,7 +60,6 @@
   http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
   (Win32)
 
-
 Step 4 - Install pip
 --------------------
 
@@ -87,7 +84,6 @@
 
   SETX PATH "%PATH%;[your-python-path]\Scripts" /M
 
-
 Step 5 - Kallithea folder structure
 -----------------------------------
 
@@ -105,7 +101,6 @@
   C:\Kallithea\Env
   C:\Kallithea\Repos
 
-
 Step 6 - Install virtualenv
 ---------------------------
 
@@ -123,7 +118,6 @@
 
   virtualenv C:\Kallithea\Env
 
-
 Step 7 - Install Kallithea
 --------------------------
 
@@ -150,7 +144,6 @@
           complete. Some warnings will appear. Don't worry, they are
           normal.
 
-
 Step 8 - Install git (optional)
 -------------------------------
 
@@ -160,7 +153,6 @@
 
 See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
 
-
 Step 9 - Configuring Kallithea
 ------------------------------
 
@@ -200,7 +192,6 @@
 
 If you decided not to install git, you will get errors about it that you can ignore.
 
-
 Step 10 - Running Kallithea
 ---------------------------
 
--- a/docs/installation_win_old.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/installation_win_old.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -4,6 +4,7 @@
 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
 ======================================================================
 
+
 First-time install
 ::::::::::::::::::
 
@@ -24,7 +25,6 @@
 Step 1 - Install Visual Studio 2008 Express
 -------------------------------------------
 
-
 Optional: You can also install MinGW, but VS2008 installation is easier.
 
 Download "Visual C++ 2008 Express Edition with SP1" from:
@@ -56,7 +56,6 @@
    I am not sure why this is not necessary for 32-bit.
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 
-
 Step 2 -- Install Python
 ------------------------
 
@@ -73,7 +72,6 @@
 
    64-bit: Just download and install the 64-bit version of python.
 
-
 Step 3 -- Install Win32py extensions
 ------------------------------------
 
@@ -93,7 +91,6 @@
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 
-
 Step 4 -- Python BIN
 --------------------
 
@@ -121,7 +118,6 @@
   Please substitute [your-python-path] with your Python installation path.
   Typically: C:\\Python27
 
-
 Step 5 -- Kallithea folder structure
 ------------------------------------
 
@@ -139,7 +135,6 @@
   C:\Kallithea\Env
   C:\Kallithea\Repos
 
-
 Step 6 -- Install virtualenv
 ----------------------------
 
@@ -160,7 +155,6 @@
 (--no-site-packages is now the default behaviour of virtualenv, no need
 to include it)
 
-
 Step 7 -- Install Kallithea
 ---------------------------
 
@@ -199,7 +193,6 @@
 
 Some warnings will appear, don't worry as they are normal.
 
-
 Step 8 -- Configuring Kallithea
 -------------------------------
 
@@ -238,11 +231,9 @@
 If you make some mistake and the script does not end, don't worry, start
 it again.
 
-
 Step 9 -- Running Kallithea
 ---------------------------
 
-
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
 just type::
 
@@ -257,7 +248,6 @@
 again. Don't forget the "http://" in Internet Explorer
 
 
-
 What this Guide does not cover:
 
 - Installing Celery
--- a/docs/overview.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/overview.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -4,7 +4,6 @@
 Installation overview
 =====================
 
-
 Some overview and some details that can help understanding the options when
 installing Kallithea.
 
--- a/docs/setup.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/setup.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -121,6 +121,7 @@
           to the Kallithea db and run check functions for permissions
           against that.
 
+
 Setting up Whoosh full text search
 ----------------------------------
 
@@ -384,7 +385,6 @@
 It's also possible for an administrator to create accounts and configure their
 permissions before the user logs in for the first time, using the :ref:`create-user` API.
 
-
 Container-based authentication
 ''''''''''''''''''''''''''''''
 
@@ -395,7 +395,6 @@
 to configure it to require authentication on the location configured for
 Kallithea.
 
-
 Proxy pass-through authentication
 '''''''''''''''''''''''''''''''''
 
@@ -710,6 +709,7 @@
 
 then change ``<someprefix>`` into your chosen prefix
 
+
 Apache with mod_wsgi
 --------------------
 
@@ -807,6 +807,7 @@
 
 .. __: https://kallithea-scm.org/repos/kallithea/files/tip/init.d/ .
 
+
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _Mercurial: http://mercurial.selenic.com/
--- a/docs/usage/backup.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/backup.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -10,6 +10,7 @@
 
 Just copy your .ini file, it contains all Kallithea settings.
 
+
 Whoosh index
 ------------
 
--- a/docs/usage/debugging.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/debugging.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -9,6 +9,7 @@
 
 .. note:: First make sure you're using the latest version available.
 
+
 Enable detailed debug
 ---------------------
 
--- a/docs/usage/email.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/email.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -15,6 +15,7 @@
 port (``smtp_port``), encryption settings (``smtp_use_tls`` or ``smtp_use_ssl``)
 and/or specific authentication parameters (``smtp_auth``).
 
+
 Application emails
 ------------------
 
@@ -42,6 +43,7 @@
 optionally be prefixed with the value of ``email_prefix`` in the configuration
 file.
 
+
 Error emails
 ------------
 
@@ -61,10 +63,12 @@
 standard SMTP port (25). If you have a remote SMTP server with a different port,
 you could set up a local forwarding SMTP server on port 25.
 
+
 References
 ----------
 
 - `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
 - `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_
 
+
 .. _WebError: https://pypi.python.org/pypi/WebError
--- a/docs/usage/general.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/general.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -27,6 +27,7 @@
 Kallithea and deletes a repository, you can easily restore such an action by
 renaming the repository directory, removing the ``rm__<date>`` prefix.
 
+
 File view: follow current branch
 --------------------------------
 
--- a/docs/usage/performance.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/performance.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -54,4 +54,5 @@
       that will separate regular user traffic from automated processes like CI
       servers or build bots.
 
+
 .. _SQLAlchemyGrate: https://github.com/shazow/sqlalchemygrate
--- a/docs/usage/vcs_support.rst	Wed Aug 26 17:28:58 2015 +0200
+++ b/docs/usage/vcs_support.rst	Wed Aug 26 17:28:58 2015 +0200
@@ -17,11 +17,14 @@
        #'git': 'Git repository',
    }
 
+
 Git support
 -----------
 
+
 Web server with chunked encoding
 ````````````````````````````````
+
 Large Git pushes require an HTTP server with support for
 chunked encoding for POST. The Python web servers waitress_ and
 gunicorn_ (Linux only) can be used. By default, Kallithea uses
@@ -47,8 +50,10 @@
 Mercurial support
 -----------------
 
+
 Working with Mercurial subrepositories
 ``````````````````````````````````````
+
 This section explains how to use Mercurial subrepositories_ in Kallithea.
 
 Example usage::
@@ -77,6 +82,7 @@
 Next we can edit the subrepository data, and push back to Kallithea. This will
 update both repositories.
 
+
 .. _waitress: http://pypi.python.org/pypi/waitress
 .. _gunicorn: http://pypi.python.org/pypi/gunicorn
 .. _subrepositories: http://mercurial.aragost.com/kick-start/en/subrepositories/
--- a/kallithea/i18n/how_to	Wed Aug 26 17:28:58 2015 +0200
+++ b/kallithea/i18n/how_to	Wed Aug 26 17:28:58 2015 +0200
@@ -9,6 +9,7 @@
 Registered users may contribute to the existing languages, or request a new
 language translations.
 
+
 Translating using Weblate
 -------------------------
 
@@ -26,6 +27,7 @@
 format parameters, untranslated strings copied into the translation. Please perform
 necessary corrections when they're needed, or override the false positives.
 
+
 Merging translations from Weblate
 ---------------------------------
 
@@ -41,6 +43,7 @@
 which case it should be manually convinced it has to discard the commits it created by
 using its administrative interface.
 
+
 Manual creation of a new language translation
 ---------------------------------------------
 
@@ -66,6 +69,7 @@
 
     python setup.py compile_catalog -l <new_language_code>
 
+
 Updating translations
 ---------------------
 
@@ -80,6 +84,7 @@
 Edit the new updated translation file. Repeat all steps after `init_catalog` step from
 new translation instructions
 
+
 Testing translations
 --------------------