upstream/kallithea Commit - r5568:ed2fb6e8

docs: use consistent style for section titles

Mads Kiilerich -

r5568:ed2fb6e8 default

parent child

README.rst

0 +3 -3

             - convert the database in a one-time step
             Maintaining interoperability
-            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Interoperability with RhodeCode 2.2.X installations is provided so you don't
             have to immediately commit to switching to Kallithea. This option will most
             ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
             One-time conversion
-            ~~~~~~~~~~~~~~~~~~~
+            ^^^^^^^^^^^^^^^^^^^
             Alternatively, if you would like to convert the database for good, you can use
             a helper script provided by Kallithea. This script will operate directly on the
                above, watch out for stray brand.pyc after removing brand.py.
             Git hooks
-            ~~~~~~~~~
+            ^^^^^^^^^
             After switching to Kallithea, it will be necessary to update the Git_ hooks in
             your repositories. If not, the Git_ hooks from RhodeCode will still be called,

docs/api/api.rst

0 +30 -30

             API access for web views
-            ++++++++++++++++++++++++
+            ------------------------
             API access can also be turned on for each web view in Kallithea that is
             decorated with the ``@LoginRequired`` decorator. Some views use
             API access
-            ++++++++++
+            ----------
             Clients must send JSON encoded JSON-RPC requests::
             API client
-            ++++++++++
+            ----------
             Kallithea comes with a ``kallithea-api`` command line tool, providing a convenient
             way to call the JSON-RPC API.
             API methods
-            +++++++++++
+            -----------
             pull
-            ----
+            ^^^^
             Pull the given repo from remote location. Can be used to automatically keep
             remote repos up to date.
                 error :  null
             rescan_repos
-            ------------
+            ^^^^^^^^^^^^
             Rescan repositories. If ``remove_obsolete`` is set,
             Kallithea will delete repos that are in the database but not in the filesystem.
                 error :  null
             invalidate_cache
-            ----------------
+            ^^^^^^^^^^^^^^^^
             Invalidate the cache for a repository.
             This command can only be executed using the api_key of a user with admin rights,
                 error :  null
             lock
-            ----
+            ^^^^
             Set the locking state on the given repository by the given user.
             If the param ``userid`` is skipped, it is set to the ID of the user who is calling this method.
                 error :  null
             get_ip
-            ------
+            ^^^^^^
             Return IP address as seen from Kallithea server, together with all
             defined IP addresses for given user.
                 error :  null
             get_user
-            --------
+            ^^^^^^^^
             Get a user by username or userid. The result is empty if user can't be found.
             If userid param is skipped, it is set to id of user who is calling this method.
                 error:  null
             get_users
-            ---------
+            ^^^^^^^^^
             List all existing users.
             This command can only be executed using the api_key of a user with admin rights.
             .. _create-user:
             create_user
-            -----------
+            ^^^^^^^^^^^
             Create new user.
             This command can only be executed using the api_key of a user with admin rights.
                 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
-            -----------
+            ^^^^^^^^^^^
             Update the given user if such user exists.
             This command can only be executed using the api_key of a user with admin rights.
                 error:  null
             delete_user
-            -----------
+            ^^^^^^^^^^^
             Delete the given user if such a user exists.
             This command can only be executed using the api_key of a user with admin rights.
                 error:  null
             get_user_group
-            --------------
+            ^^^^^^^^^^^^^^
             Get an existing user group.
             This command can only be executed using the api_key of a user with admin rights.
                 error : null
             get_user_groups
-            ---------------
+            ^^^^^^^^^^^^^^^
             List all existing user groups.
             This command can only be executed using the api_key of a user with admin rights.
                 error : null
             create_user_group
-            -----------------
+            ^^^^^^^^^^^^^^^^^
             Create a new user group.
             This command can only be executed using the api_key of a user with admin rights.
                 error:  null
             add_user_to_user_group
-            ----------------------
+            ^^^^^^^^^^^^^^^^^^^^^^
             Adds a user to a user group. If the user already is in that group, success will be
             ``false``.
                 error:  null
             remove_user_from_user_group
-            ---------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Remove a user from a user group. If the user isn't in the given group, success will
             be ``false``.
                 error:  null
             get_repo
-            --------
+            ^^^^^^^^
             Get an existing repository by its name or repository_id. Members will contain
             either users_group or users associated to that repository.
                 error:  null
             get_repos
-            ---------
+            ^^^^^^^^^
             List all existing repositories.
             This command can only be executed using the api_key of a user with admin rights,
                 error:  null
             get_repo_nodes
-            --------------
+            ^^^^^^^^^^^^^^
             Return a list of files and directories for a given path at the given revision.
             It is possible to specify ret_type to show only ``files`` or ``dirs``.
                 error:  null
             create_repo
-            -----------
+            ^^^^^^^^^^^
             Create a repository. If the repository name contains "/", all needed repository
             groups will be created. For example "foo/bar/baz" will create repository groups
                 error:  null
             update_repo
-            -----------
+            ^^^^^^^^^^^
             Update a repository.
             This command can only be executed using the api_key of a user with admin rights,
                 error:  null
             fork_repo
-            ---------
+            ^^^^^^^^^
             Create a fork of the given repo. If using Celery, this will
             return success message immediately and a fork will be created
                 error:  null
             delete_repo
-            -----------
+            ^^^^^^^^^^^
             Delete a repository.
             This command can only be executed using the api_key of a user with admin rights,
                 error:  null
             grant_user_permission
-            ---------------------
+            ^^^^^^^^^^^^^^^^^^^^^
             Grant permission for a user on the given repository, or update the existing one if found.
             This command can only be executed using the api_key of a user with admin rights.
                 error:  null
             revoke_user_permission
-            ----------------------
+            ^^^^^^^^^^^^^^^^^^^^^^
             Revoke permission for a user on the given repository.
             This command can only be executed using the api_key of a user with admin rights.
                 error:  null
             grant_user_group_permission
-            ---------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Grant permission for a user group on the given repository, or update the
             existing one if found.
                 error:  null
             revoke_user_group_permission
-            ----------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Revoke permission for a user group on the given repository.
             This command can only be executed using the api_key of a user with admin rights.

docs/index.rst

0 +1 -1

             Other topics
-            ------------
+            ************
             * :ref:`genindex`
             * :ref:`search`

docs/installation_iis.rst

0 +3 -3

             own virtual folder will be noted where appropriate.
             Application pool
-            ................
+            ^^^^^^^^^^^^^^^^
             Make sure that there is a unique application pool for the Kallithea application
             with an identity that has read access to the Kallithea distribution.
                 as long as the Kallithea requirements are met by the existing pool.
             ISAPI handler
-            .............
+            ^^^^^^^^^^^^^
             The ISAPI handler can be generated using::
             site will be processed through this logic henceforth.
             Authentication with Kallithea using IIS authentication modules
-            ..............................................................
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             The recommended way to handle authentication with Kallithea using IIS is to let
             IIS handle all the authentication and just pass it to Kallithea.

docs/installation_win.rst

0 +12 -12

             First time install
-            ::::::::::::::::::
+            ------------------
             Target OS: Windows 7 and newer or Windows Server 2008 R2 and newer
             To install on an older version of Windows, see `<installation_win_old.html>`_
             Step 1 -- Install Python
-            ------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^
             Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
             be needed in the next step. In this case, it is "2.7".
             Step 2 -- Python BIN
-            --------------------
+            ^^^^^^^^^^^^^^^^^^^^
             Add Python BIN folder to the path. This can be done manually (editing
             "PATH" environment variable) or by using Windows Support Tools that
             path. Typically this is ``C:\\Python27``.
             Step 3 -- Install pywin32 extensions
-            ------------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Download pywin32 from:
             http://sourceforge.net/projects/pywin32/files/
               (Win32)
             Step 4 -- Install pip
-            ---------------------
+            ^^^^^^^^^^^^^^^^^^^^^
             pip is a package management system for Python. You will need it to install Kallithea and its dependencies.
               SETX PATH "%PATH%;[your-python-path]\Scripts" /M
             Step 5 -- Kallithea folder structure
-            ------------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Create a Kallithea folder structure.
               C:\Kallithea\Repos
             Step 6 -- Install virtualenv
-            ----------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             .. note::
                A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
               virtualenv C:\Kallithea\Env
             Step 7 -- Install Kallithea
-            ---------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^
             In order to install Kallithea, you need to be able to run "pip install kallithea". It will use pip to install the Kallithea Python package and its dependencies.
             Some Python packages use managed code and need to be compiled.
                       normal.
             Step 8 -- Install git (optional)
-            --------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
             See http://git-scm.com/book/en/v2/Getting-Started-Installing-Git#Installing-on-Windows for instructions.
             Step 9 -- Configuring Kallithea
-            -------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Steps taken from `<setup.html>`_
             If you decided not to install git, you will get errors about it that you can ignore.
             Step 10 -- Running Kallithea
-            ----------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             In the previous command prompt, being in the C:\\Kallithea\\Bin folder, type::
             Upgrading
-            :::::::::
+            ---------
             Stop running Kallithea
             Open a CommandPrompt like in Step 7 (cd to C:\Kallithea\Env\Scripts and activate) and type::

docs/installation_win_old.rst

0 +11 -11

             First-time install
-            ::::::::::::::::::
+            ------------------
             Target OS: Windows XP SP3 32-bit English (Clean installation)
             + All Windows Updates until 24-may-2012
                - http://bugs.python.org/issue7511
             Step 1 -- Install Visual Studio 2008 Express
-            --------------------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Optional: You can also install MinGW, but VS2008 installation is easier.
                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
-            ------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^
             Install Python 2.x.y (x = 6 or 7) x86 version (32-bit). DO NOT USE A 3.x version.
             Download Python 2.x.y from:
 -bit: Just download and install the 64-bit version of python.
             Step 3 -- Install Win32py extensions
-            ------------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Download pywin32 from:
             http://sourceforge.net/projects/pywin32/files/
                  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
             Step 4 -- Python BIN
-            --------------------
+            ^^^^^^^^^^^^^^^^^^^^
             Add Python BIN folder to the path
               Typically: C:\\Python27
             Step 5 -- Kallithea folder structure
-            ------------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Create a Kallithea folder structure
               C:\Kallithea\Repos
             Step 6 -- Install virtualenv
-            ----------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Install Virtual Env for Python
             to include it)
             Step 7 -- Install Kallithea
-            ---------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^
             Finally, install Kallithea
             Some warnings will appear, don't worry as they are normal.
             Step 8 -- Configuring Kallithea
-            -------------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             steps taken from http://packages.python.org/Kallithea/setup.html
             it again.
             Step 9 -- Running Kallithea
-            ---------------------------
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^
             In the previous command prompt, being in the C:\\Kallithea\\Bin folder,
             just type::
             Upgrading
-            :::::::::
+            ---------
             Stop running Kallithea
             Open a CommandPrompt like in Step7 (VS2008 path + activate) and type::

docs/setup.rst

0 +3 -3

             will be saved there.
             Active Directory
-            ''''''''''''''''
+            ^^^^^^^^^^^^^^^^
             Kallithea can use Microsoft Active Directory for user authentication.  This
             is done through an LDAP or LDAPS connection to Active Directory.  The
             permissions before the user logs in for the first time, using the :ref:`create-user` API.
             Container-based authentication
-            ''''''''''''''''''''''''''''''
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             In a container-based authentication setup, Kallithea reads the user name from
             the ``REMOTE_USER`` server variable provided by the WSGI container.
             Kallithea.
             Proxy pass-through authentication
-            '''''''''''''''''''''''''''''''''
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             In a proxy pass-through authentication setup, Kallithea reads the user name
             from the ``X-Forwarded-User`` request header, which should be configured to be

docs/usage/general.rst

0 +2 -2

             features that merit further explanation.
             Repository extra fields
-            ~~~~~~~~~~~~~~~~~~~~~~~
+            ^^^^^^^^^^^^^^^^^^^^^^^
             In the *Visual* tab, there is an option "Use repository extra
             fields", which allows to set custom fields for each repository in the system.
             Newly created fields are accessible via the API.
             Meta tagging
-            ~~~~~~~~~~~~
+            ^^^^^^^^^^^^
             In the *Visual* tab, option "Stylify recognised meta tags" will cause Kallithea
             to turn certain text fragments in repository and repository group

docs/usage/vcs_support.rst

0 +2 -2

             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
             Working with Mercurial subrepositories
-            ``````````````````````````````````````
+            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
             This section explains how to use Mercurial subrepositories_ in Kallithea.

scripts/docs-headings.py

0 +20 -7

@@ -15,6 +15,16 b' spaces = ['
15	(1, 0),	15	(1, 0),
16	]	16	]
17		17
		18	# http://sphinx-doc.org/rest.html :
		19	# for the Python documentation, this convention is used which you may follow:
		20	# # with overline, for parts
		21	# * with overline, for chapters
		22	# =, for sections
		23	# -, for subsections
		24	# ^, for subsubsections
		25	# ", for paragraphs
		26	pystyles = ['#', '*', '=', '-', '^', '"']
		27
18	# match on a header line underlined with one of the valid characters	28	# match on a header line underlined with one of the valid characters
19	headermatch = re.compile(r'''\n(.+)\n([][!"#$%&'()+,./:;<=>?@\\^_`{\|}~-])\2{2,}\n+''', flags=re.MULTILINE)	29	headermatch = re.compile(r'''\n(.+)\n([][!"#$%&'()+,./:;<=>?@\\^_`{\|}~-])\2{2,}\n+''', flags=re.MULTILINE)
20		30
@@ -44,13 +54,16 b' def main():'
44	# remove superfluous spacing (may however be restored by header spacing)	54	# remove superfluous spacing (may however be restored by header spacing)
45	s = re.sub(r'''(\n\n)\n*''', r'\1', s, flags=re.MULTILINE)	55	s = re.sub(r'''(\n\n)\n*''', r'\1', s, flags=re.MULTILINE)
46		56
47	# rewrite header markup with correct style, length and spacing	57	if styles:
48	def subf(m):	58	newstyles = pystyles[pystyles.index(styles[0]):]
49	title, style = m.groups()	59
50	level = styles.index(style)	60	def subf(m):
51	before, after = spaces[level]	61	title, style = m.groups()
52	return '\n' * (before + 1) + title + '\n' + style * len(title) + '\n' * (after + 1)	62	level = styles.index(style)
53	s = headermatch.sub(subf, s)	63	before, after = spaces[level]
		64	newstyle = newstyles[level]
		65	return '\n' * (before + 1) + title + '\n' + newstyle * len(title) + '\n' * (after + 1)
		66	s = headermatch.sub(subf, s)
54		67
55	# remove superfluous spacing when headers are adjacent	68	# remove superfluous spacing when headers are adjacent
56	s = re.sub(r'''(\n.+\n([][!"#$%&'()+,./:;<=>?@\\^_`{\|}~-])\2{2,}\n\n\n)\n''', r'\1', s, flags=re.MULTILINE)	69	s = re.sub(r'''(\n.+\n([][!"#$%&'()+,./:;<=>?@\\^_`{\|}~-])\2{2,}\n\n\n)\n''', r'\1', s, flags=re.MULTILINE)

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages