Changeset - 5f481e4e888b
[Not reviewed]
default
1 0 11
Marcin Kuzminski - 15 years ago 2010-10-10 17:24:41
marcin@python-works.com
updated docs, added sphinx build
11 files changed with 980 insertions and 14 deletions:
0 comments (0 inline, 0 general)
docs/Makefile
Show inline comments
 
new file 100644
 
# Makefile for Sphinx documentation
 
#
 

	
 
# You can set these variables from the command line.
 
SPHINXOPTS    =
 
SPHINXBUILD   = sphinx-build
 
PAPER         =
 
BUILDDIR      = _build
 

	
 
# Internal variables.
 
PAPEROPT_a4     = -D latex_paper_size=a4
 
PAPEROPT_letter = -D latex_paper_size=letter
 
ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 

	
 
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
 

	
 
help:
 
	@echo "Please use \`make <target>' where <target> is one of"
 
	@echo "  html       to make standalone HTML files"
 
	@echo "  dirhtml    to make HTML files named index.html in directories"
 
	@echo "  singlehtml to make a single large HTML file"
 
	@echo "  pickle     to make pickle files"
 
	@echo "  json       to make JSON files"
 
	@echo "  htmlhelp   to make HTML files and a HTML help project"
 
	@echo "  qthelp     to make HTML files and a qthelp project"
 
	@echo "  devhelp    to make HTML files and a Devhelp project"
 
	@echo "  epub       to make an epub"
 
	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
 
	@echo "  text       to make text files"
 
	@echo "  man        to make manual pages"
 
	@echo "  changes    to make an overview of all changed/added/deprecated items"
 
	@echo "  linkcheck  to check all external links for integrity"
 
	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
 

	
 
clean:
 
	-rm -rf $(BUILDDIR)/*
 

	
 
html:
 
	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 
	@echo
 
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 

	
 
dirhtml:
 
	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 
	@echo
 
	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
 

	
 
singlehtml:
 
	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
 
	@echo
 
	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
 

	
 
pickle:
 
	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
 
	@echo
 
	@echo "Build finished; now you can process the pickle files."
 

	
 
json:
 
	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
 
	@echo
 
	@echo "Build finished; now you can process the JSON files."
 

	
 
htmlhelp:
 
	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
 
	@echo
 
	@echo "Build finished; now you can run HTML Help Workshop with the" \
 
	      ".hhp project file in $(BUILDDIR)/htmlhelp."
 

	
 
qthelp:
 
	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
 
	@echo
 
	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 
	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
 
	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RhodeCode.qhcp"
 
	@echo "To view the help file:"
 
	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RhodeCode.qhc"
 

	
 
devhelp:
 
	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
 
	@echo
 
	@echo "Build finished."
 
	@echo "To view the help file:"
 
	@echo "# mkdir -p $$HOME/.local/share/devhelp/RhodeCode"
 
	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RhodeCode"
 
	@echo "# devhelp"
 

	
 
epub:
 
	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
 
	@echo
 
	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
 

	
 
latex:
 
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 
	@echo
 
	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
 
	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 
	      "(use \`make latexpdf' here to do that automatically)."
 

	
 
latexpdf:
 
	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 
	@echo "Running LaTeX files through pdflatex..."
 
	make -C $(BUILDDIR)/latex all-pdf
 
	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 

	
 
text:
 
	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 
	@echo
 
	@echo "Build finished. The text files are in $(BUILDDIR)/text."
 

	
 
man:
 
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
 
	@echo
 
	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
 

	
 
changes:
 
	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
 
	@echo
 
	@echo "The overview file is in $(BUILDDIR)/changes."
 

	
 
linkcheck:
 
	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 
	@echo
 
	@echo "Link check complete; look for any errors in the above output " \
 
	      "or in $(BUILDDIR)/linkcheck/output.txt."
 

	
 
doctest:
 
	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
 
	@echo "Testing of doctests in the sources finished, look at the " \
 
	      "results in $(BUILDDIR)/doctest/output.txt."
docs/conf.py
Show inline comments
 
new file 100644
 
# -*- coding: utf-8 -*-
 
#
 
# RhodeCode documentation build configuration file, created by
 
# sphinx-quickstart on Sun Oct 10 16:46:37 2010.
 
#
 
# This file is execfile()d with the current directory set to its containing dir.
 
#
 
# Note that not all possible configuration values are present in this
 
# autogenerated file.
 
#
 
# All configuration values have a default; values that are commented out
 
# serve to show the default.
 

	
 
import sys, os
 

	
 
# If extensions (or modules to document with autodoc) are in another directory,
 
# add these directories to sys.path here. If the directory is relative to the
 
# documentation root, use os.path.abspath to make it absolute, like shown here.
 
#sys.path.insert(0, os.path.abspath('.'))
 

	
 
# -- General configuration -----------------------------------------------------
 

	
 
# If your documentation needs a minimal Sphinx version, state it here.
 
#needs_sphinx = '1.0'
 

	
 
# Add any Sphinx extension module names here, as strings. They can be extensions
 
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
 

	
 
# Add any paths that contain templates here, relative to this directory.
 
templates_path = ['_templates']
 

	
 
# The suffix of source filenames.
 
source_suffix = '.rst'
 

	
 
# The encoding of source files.
 
#source_encoding = 'utf-8-sig'
 

	
 
# The master toctree document.
 
master_doc = 'index'
 

	
 
# General information about the project.
 
project = u'RhodeCode'
 
copyright = u'2010, Marcin Kuzminski'
 

	
 
# The version info for the project you're documenting, acts as replacement for
 
# |version| and |release|, also used in various other places throughout the
 
# built documents.
 
#
 
# The short X.Y version.
 
version = '1.0.0'
 
# The full version, including alpha/beta/rc tags.
 
release = '1.0.0rc1'
 

	
 
# The language for content autogenerated by Sphinx. Refer to documentation
 
# for a list of supported languages.
 
#language = None
 

	
 
# There are two options for replacing |today|: either, you set today to some
 
# non-false value, then it is used:
 
#today = ''
 
# Else, today_fmt is used as the format for a strftime call.
 
#today_fmt = '%B %d, %Y'
 

	
 
# List of patterns, relative to source directory, that match files and
 
# directories to ignore when looking for source files.
 
exclude_patterns = ['_build']
 

	
 
# The reST default role (used for this markup: `text`) to use for all documents.
 
#default_role = None
 

	
 
# If true, '()' will be appended to :func: etc. cross-reference text.
 
#add_function_parentheses = True
 

	
 
# If true, the current module name will be prepended to all description
 
# unit titles (such as .. function::).
 
#add_module_names = True
 

	
 
# If true, sectionauthor and moduleauthor directives will be shown in the
 
# output. They are ignored by default.
 
#show_authors = False
 

	
 
# The name of the Pygments (syntax highlighting) style to use.
 
pygments_style = 'sphinx'
 

	
 
# A list of ignored prefixes for module index sorting.
 
#modindex_common_prefix = []
 

	
 

	
 
# -- Options for HTML output ---------------------------------------------------
 

	
 
# The theme to use for HTML and HTML Help pages.  See the documentation for
 
# a list of builtin themes.
 
html_theme = 'nature'
 

	
 
# Theme options are theme-specific and customize the look and feel of a theme
 
# further.  For a list of options available for each theme, see the
 
# documentation.
 
#html_theme_options = {}
 

	
 
# Add any paths that contain custom themes here, relative to this directory.
 
html_theme_path = ['theme']
 

	
 
# The name for this set of Sphinx documents.  If None, it defaults to
 
# "<project> v<release> documentation".
 
#html_title = None
 

	
 
# A shorter title for the navigation bar.  Default is the same as html_title.
 
#html_short_title = None
 

	
 
# The name of an image file (relative to this directory) to place at the top
 
# of the sidebar.
 
#html_logo = None
 

	
 
# The name of an image file (within the static path) to use as favicon of the
 
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 
# pixels large.
 
#html_favicon = None
 

	
 
# Add any paths that contain custom static files (such as style sheets) here,
 
# relative to this directory. They are copied after the builtin static files,
 
# so a file named "default.css" will overwrite the builtin "default.css".
 
html_static_path = ['_static']
 

	
 
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 
# using the given strftime format.
 
#html_last_updated_fmt = '%b %d, %Y'
 

	
 
# If true, SmartyPants will be used to convert quotes and dashes to
 
# typographically correct entities.
 
#html_use_smartypants = True
 

	
 
# Custom sidebar templates, maps document names to template names.
 
#html_sidebars = {}
 

	
 
# Additional templates that should be rendered to pages, maps page names to
 
# template names.
 
#html_additional_pages = {}
 

	
 
# If false, no module index is generated.
 
#html_domain_indices = True
 

	
 
# If false, no index is generated.
 
#html_use_index = True
 

	
 
# If true, the index is split into individual pages for each letter.
 
#html_split_index = False
 

	
 
# If true, links to the reST sources are added to the pages.
 
#html_show_sourcelink = True
 

	
 
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 
#html_show_sphinx = True
 

	
 
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 
#html_show_copyright = True
 

	
 
# If true, an OpenSearch description file will be output, and all pages will
 
# contain a <link> tag referring to it.  The value of this option must be the
 
# base URL from which the finished HTML is served.
 
#html_use_opensearch = ''
 

	
 
# This is the file name suffix for HTML files (e.g. ".xhtml").
 
#html_file_suffix = None
 

	
 
# Output file base name for HTML help builder.
 
htmlhelp_basename = 'RhodeCodedoc'
 

	
 

	
 
# -- Options for LaTeX output --------------------------------------------------
 

	
 
# The paper size ('letter' or 'a4').
 
#latex_paper_size = 'letter'
 

	
 
# The font size ('10pt', '11pt' or '12pt').
 
#latex_font_size = '10pt'
 

	
 
# Grouping the document tree into LaTeX files. List of tuples
 
# (source start file, target name, title, author, documentclass [howto/manual]).
 
latex_documents = [
 
  ('index', 'RhodeCode.tex', u'RhodeCode Documentation',
 
   u'Marcin Kuzminski', 'manual'),
 
]
 

	
 
# The name of an image file (relative to this directory) to place at the top of
 
# the title page.
 
#latex_logo = None
 

	
 
# For "manual" documents, if this is true, then toplevel headings are parts,
 
# not chapters.
 
#latex_use_parts = False
 

	
 
# If true, show page references after internal links.
 
#latex_show_pagerefs = False
 

	
 
# If true, show URL addresses after external links.
 
#latex_show_urls = False
 

	
 
# Additional stuff for the LaTeX preamble.
 
#latex_preamble = ''
 

	
 
# Documents to append as an appendix to all manuals.
 
#latex_appendices = []
 

	
 
# If false, no module index is generated.
 
#latex_domain_indices = True
 

	
 

	
 
# -- Options for manual page output --------------------------------------------
 

	
 
# One entry per manual page. List of tuples
 
# (source start file, name, description, authors, manual section).
 
man_pages = [
 
    ('index', 'rhodecode', u'RhodeCode Documentation',
 
     [u'Marcin Kuzminski'], 1)
 
]
 

	
 

	
 
# Example configuration for intersphinx: refer to the Python standard library.
 
intersphinx_mapping = {'http://docs.python.org/': None}
docs/images/screenshot1_main_page.png
Show inline comments
 
new file 100644
 
binary diff not shown
Show images
docs/images/screenshot2_summary_page.png
Show inline comments
 
new file 100644
 
binary diff not shown
Show images
docs/index.rst
Show inline comments
 
file renamed from docs/index.txt to docs/index.rst
 
rhodecode
 
++++++++++
 
.. _index:
 

	
 
Welcome to RhodeCode (RhodiumCode) documentation!
 
=================================================
 

	
 
``RhodeCode`` is Pylons based repository management and serving for mercurial. 
 
It's similar to github or bitbucket, but focuses more on closed access restrictions.
 
There's no default free access to RhodeCode You have to create an account in order
 
to use the application. 
 

	
 

	
 
RhodeCode uses `Semantic Versioning <http://semver.org/>`_
 

	
 
**Features**
 

	
 
This is the main index page of your documentation. It should be written in
 
`reStructuredText format <http://docutils.sourceforge.net/rst.html>`_.
 
- Has it's own middleware to handle mercurial protocol request. Each request can 
 
  be logged and authenticated. Runs on threads unlikely to hgweb You can make
 
  multiple pulls/pushes simultaneous
 
- Full permissions and authentication per project private/read/write/admin. 
 
  One account for web interface and mercurial push/pull/clone.
 
- Mako templates let's you customize look and feel of application.
 
- Beautiful diffs, annotations and source codes all colored by pygments.
 
- Mercurial branch graph and yui-flot powered graphs with zooming and statistics
 
- Admin interface with user/permission management. User activity journal logs
 
  pulls, pushes, forks,registrations. Possible to disable built in hooks
 
- Server side forks, it's possible to fork a project and hack it free without
 
  breaking the main.   
 
- Full text search on source codes, search on file names. All powered by whoosh
 
  and build in indexing daemons
 
  (no external search servers required all in one application)
 
- Rss / atom feeds, gravatar support, download sources as zip/tarballs  
 
- Async tasks for speed and performance using celery (works without them too)  
 
- Backup scripts can do backup of whole app and send it over scp to desired 
 
  location
 
- Setup project descriptions and info inside built in db for easy, non 
 
  file-system operations
 
- Added cache with invalidation on push/repo management for high performance and
 
  always up to date data. 
 
- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
 

	
 
You can generate your documentation in HTML format by running this command::
 

	
 
    setup.py pudge
 

	
 
For this to work you will need to download and install `buildutils`_,
 
`pudge`_, and `pygments`_.  The ``pudge`` command is disabled by
 
default; to ativate it in your project, run::
 
.. figure::  images/screenshot1_main_page.png
 
   :align:   left
 

	
 
   Main page of RhodeCode
 

	
 
.. figure::  images/screenshot2_summary_page.png
 
   :align:   left
 

	
 
   Summary page
 

	
 

	
 
**Incoming**
 

	
 
- code review based on hg-review (when it's stable)
 
- git support (when vcs can handle it - almost there !)
 
- commit based wikis
 
- clonning from remote repositories into rhodecode (git/mercurial)
 
- other cools stuff that i can figure out (or You can help me figure out)
 

	
 
    setup.py addcommand -p buildutils.pudge_command
 
Documentation
 
=============
 

	
 
**Installation:**
 

	
 
.. toctree::
 
   :maxdepth: 1
 

	
 
   installation
 
   setup
 

	
 
.. _buildutils: http://pypi.python.org/pypi/buildutils
 
.. _pudge: http://pudge.lesscode.org/
 
.. _pygments: http://pygments.org/
 
Other topics
 
============
 

	
 
* :ref:`genindex`
 
* :ref:`search`
 

	
 
.. _python: http://www.python.org/
 
.. _django: http://www.djangoproject.com/
 
.. _mercurial: http://mercurial.selenic.com/
 
.. _subversion: http://subversion.tigris.org/
 
.. _git: http://git-scm.com/
 
\ No newline at end of file
docs/installation.rst
Show inline comments
 
new file 100644
 
.. _installation:
 

	
 
Installation
 
============
 

	
 
``RhodeCode`` is written entirely in Python, but in order to use it's full
 
potential there are some third-party requirements. When RhodeCode is used 
 
together with celery You have to install some kind of message broker,
 
recommended one is rabbitmq to make the async tasks work.
 
For installation instructions You can visit: 
 
http://ask.github.com/celery/getting-started/index.html.
 

	
 
Of course RhodeCode works in sync mode also, then You don't have to install
 
any third party apps. Celery will give You large speed improvement when using
 
many big repositories. If You plan to use it for 2 or 3 small repositories, it
 
will work just fine without celery running.
 
   
 
After You decide to Run it with celery make sure You run celeryd and
 
message broker together with the application.   
 

	
 
Requirements for Celery
 
-----------------------
 

	
 
**Message Broker** 
 

	
 
- preferred is `RabbitMq <http://www.rabbitmq.com/>`_
 
- possible other is `Redis <http://code.google.com/p/redis/>`_
 

	
 

	
 
Install from Cheese Shop
 
------------------------
 

	
 
Easiest way to install ``rhodecode`` is to run::
 

	
 
   easy_install rhodecode
 

	
 
Or::
 

	
 
   pip install rhodecode
 

	
 
If you prefer to install manually simply grab latest release from
 
http://pypi.python.org/pypi/rhodecode, decompres archive and run::
 

	
 
   python setup.py install
 

	
 

	
 
**Setting up the application**
 
I recommend to run the RhodeCode in separate virtualenv.
 
See http://pypi.python.org/pypi/virtualenv for more details.
 

	
 
- run `paster make-config RhodeCode production.ini` make specific application
 
  config, 
 
- run `paster setup-app production.ini` makes the database, and propagates it
 
  with default data, In this step You have to provide admin username and repositories
 
  location, it can be a new location or with existing ones in that case RhodeCode
 
  will scann all new found repos and put it into database.
 
- run `paster runserver production.ini` runs the server.
 

	
 

	
 
**STEP BY STEP EXAMPLE INSTRUCTION**
 

	
 

	
 
- Assuming You have setup virtualenv create one using 
 
  `virtualenv --no-site-packages /var/www/rhodecode-venv`
 
  this will install new virtual env into /var/www/rhodecode-venv. 
 
- Activate the virtualenv by running 
 
  `source activate /var/www/rhodecode-venv/bin/activate`   
 
- Make a folder for rhodecode somewhere on the filesystem for example 
 
  /var/www/rhodecode  
 
- Run easy_install rhodecode, this will install rhodecode together with pylons
 
  and all other required python libraries
 
- Run `paster make-config RhodeCode production.ini` in order to install 
 
  the application config. 
 
- Run `paster setup-app production.ini` it should create all needed tables 
 
  and an admin account. Also make sure You specify correct path to repositories.
 
  You can either use a new location of one with already exising ones. RhodeCode
 
  will simply add all new found repositories to it's database. 
 
- Remember that the given path for mercurial repositories must be write 
 
  accessible for the application. It's very important since RhodeCode web interface
 
  will work even without such an access but, when trying to do a push it's eventually
 
  failed with permission denied. 
 
- Run `paster serve production.ini`
 
  the app should be available at the 127.0.0.1:5000
 
- Use admin account you created to login.
 
- Default permissions on each repository is read, and owner is admin. So remember
 
  to update these.
 

	
 
- All needed configs are inside rhodecode sources ie. celeryconfig.py, 
 
  development.ini, production.ini You can configure the email, ports, loggers, 
 
  workers from there.
 
- For full text search You can either put crontab entry for 
 
  `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>`
 
  or run indexer from admin panel. This will scann the repos given in the 
 
  application setup or given path for daemon.py and each scann in incremental 
 
  mode will scan only changed files.
 
\ No newline at end of file
docs/make.bat
Show inline comments
 
new file 100644
 
@ECHO OFF
 

	
 
REM Command file for Sphinx documentation
 

	
 
if "%SPHINXBUILD%" == "" (
 
	set SPHINXBUILD=sphinx-build
 
)
 
set BUILDDIR=_build
 
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
 
if NOT "%PAPER%" == "" (
 
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 
)
 

	
 
if "%1" == "" goto help
 

	
 
if "%1" == "help" (
 
	:help
 
	echo.Please use `make ^<target^>` where ^<target^> is one of
 
	echo.  html       to make standalone HTML files
 
	echo.  dirhtml    to make HTML files named index.html in directories
 
	echo.  singlehtml to make a single large HTML file
 
	echo.  pickle     to make pickle files
 
	echo.  json       to make JSON files
 
	echo.  htmlhelp   to make HTML files and a HTML help project
 
	echo.  qthelp     to make HTML files and a qthelp project
 
	echo.  devhelp    to make HTML files and a Devhelp project
 
	echo.  epub       to make an epub
 
	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
 
	echo.  text       to make text files
 
	echo.  man        to make manual pages
 
	echo.  changes    to make an overview over all changed/added/deprecated items
 
	echo.  linkcheck  to check all external links for integrity
 
	echo.  doctest    to run all doctests embedded in the documentation if enabled
 
	goto end
 
)
 

	
 
if "%1" == "clean" (
 
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
 
	del /q /s %BUILDDIR%\*
 
	goto end
 
)
 

	
 
if "%1" == "html" (
 
	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
 
	echo.
 
	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
 
	goto end
 
)
 

	
 
if "%1" == "dirhtml" (
 
	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
 
	echo.
 
	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
 
	goto end
 
)
 

	
 
if "%1" == "singlehtml" (
 
	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
 
	echo.
 
	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
 
	goto end
 
)
 

	
 
if "%1" == "pickle" (
 
	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
 
	echo.
 
	echo.Build finished; now you can process the pickle files.
 
	goto end
 
)
 

	
 
if "%1" == "json" (
 
	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
 
	echo.
 
	echo.Build finished; now you can process the JSON files.
 
	goto end
 
)
 

	
 
if "%1" == "htmlhelp" (
 
	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
 
	echo.
 
	echo.Build finished; now you can run HTML Help Workshop with the ^
 
.hhp project file in %BUILDDIR%/htmlhelp.
 
	goto end
 
)
 

	
 
if "%1" == "qthelp" (
 
	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
 
	echo.
 
	echo.Build finished; now you can run "qcollectiongenerator" with the ^
 
.qhcp project file in %BUILDDIR%/qthelp, like this:
 
	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\RhodeCode.qhcp
 
	echo.To view the help file:
 
	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\RhodeCode.ghc
 
	goto end
 
)
 

	
 
if "%1" == "devhelp" (
 
	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
 
	echo.
 
	echo.Build finished.
 
	goto end
 
)
 

	
 
if "%1" == "epub" (
 
	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
 
	echo.
 
	echo.Build finished. The epub file is in %BUILDDIR%/epub.
 
	goto end
 
)
 

	
 
if "%1" == "latex" (
 
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
 
	echo.
 
	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
 
	goto end
 
)
 

	
 
if "%1" == "text" (
 
	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
 
	echo.
 
	echo.Build finished. The text files are in %BUILDDIR%/text.
 
	goto end
 
)
 

	
 
if "%1" == "man" (
 
	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
 
	echo.
 
	echo.Build finished. The manual pages are in %BUILDDIR%/man.
 
	goto end
 
)
 

	
 
if "%1" == "changes" (
 
	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
 
	echo.
 
	echo.The overview file is in %BUILDDIR%/changes.
 
	goto end
 
)
 

	
 
if "%1" == "linkcheck" (
 
	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
 
	echo.
 
	echo.Link check complete; look for any errors in the above output ^
 
or in %BUILDDIR%/linkcheck/output.txt.
 
	goto end
 
)
 

	
 
if "%1" == "doctest" (
 
	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
 
	echo.
 
	echo.Testing of doctests in the sources finished, look at the ^
 
results in %BUILDDIR%/doctest/output.txt.
 
	goto end
 
)
 

	
 
:end
docs/setup.rst
Show inline comments
 
new file 100644
 
.. _setup:
 

	
 
Setup
 
=====
 

	
 

	
 
- All needed configs are inside rhodecode sources ie. celeryconfig.py, 
 
  development.ini, production.ini You can configure the email, ports, loggers, 
 
  workers from there.
 
- For full text search You can either put crontab entry for 
 
  `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>`
 
  or run indexer from admin panel. This will scann the repos given in the 
 
  application setup or given path for daemon.py and each scann in incremental 
 
  mode will scan only changed files.
 
  
 
TODO: write that !
 
\ No newline at end of file
docs/theme/nature/static/nature.css_t
Show inline comments
 
new file 100644
 
/**
 
 * Sphinx stylesheet -- default theme
 
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 */
 
 
 
@import url("basic.css");
 
 
 
/* -- page layout ----------------------------------------------------------- */
 
 
 
body {
 
    font-family: Arial, sans-serif;
 
    font-size: 100%;
 
    background-color: #111;
 
    color: #555;
 
    margin: 0;
 
    padding: 0;
 
}
 

	
 
div.documentwrapper {
 
    float: left;
 
    width: 100%;
 
}
 

	
 
div.bodywrapper {
 
    margin: 0 0 0 230px;
 
}
 

	
 
hr{
 
    border: 1px solid #B1B4B6;
 
}
 
 
 
div.document {
 
    background-color: #eee;
 
}
 
 
 
div.body {
 
    background-color: #ffffff;
 
    color: #3E4349;
 
    padding: 0 30px 30px 30px;
 
    font-size: 0.8em;
 
}
 
 
 
div.footer {
 
    color: #555;
 
    width: 100%;
 
    padding: 13px 0;
 
    text-align: center;
 
    font-size: 75%;
 
}
 
 
 
div.footer a {
 
    color: #444;
 
    text-decoration: underline;
 
}
 
 
 
div.related {
 
    background-color: #6BA81E;
 
    line-height: 32px;
 
    color: #fff;
 
    text-shadow: 0px 1px 0 #444;
 
    font-size: 0.80em;
 
}
 
 
 
div.related a {
 
    color: #E2F3CC;
 
}
 
 
 
div.sphinxsidebar {
 
    font-size: 0.75em;
 
    line-height: 1.5em;
 
}
 

	
 
div.sphinxsidebarwrapper{
 
    padding: 20px 0;
 
}
 
 
 
div.sphinxsidebar h3,
 
div.sphinxsidebar h4 {
 
    font-family: Arial, sans-serif;
 
    color: #222;
 
    font-size: 1.2em;
 
    font-weight: normal;
 
    margin: 0;
 
    padding: 5px 10px;
 
    background-color: #ddd;
 
    text-shadow: 1px 1px 0 white
 
}
 

	
 
div.sphinxsidebar h4{
 
    font-size: 1.1em;
 
}
 
 
 
div.sphinxsidebar h3 a {
 
    color: #444;
 
}
 
 
 
 
 
div.sphinxsidebar p {
 
    color: #888;
 
    padding: 5px 20px;
 
}
 
 
 
div.sphinxsidebar p.topless {
 
}
 
 
 
div.sphinxsidebar ul {
 
    margin: 10px 20px;
 
    padding: 0;
 
    color: #000;
 
}
 
 
 
div.sphinxsidebar a {
 
    color: #444;
 
}
 
 
 
div.sphinxsidebar input {
 
    border: 1px solid #ccc;
 
    font-family: sans-serif;
 
    font-size: 1em;
 
}
 

	
 
div.sphinxsidebar input[type=text]{
 
    margin-left: 20px;
 
}
 
 
 
/* -- body styles ----------------------------------------------------------- */
 
 
 
a {
 
    color: #005B81;
 
    text-decoration: none;
 
}
 
 
 
a:hover {
 
    color: #E32E00;
 
    text-decoration: underline;
 
}
 
 
 
div.body h1,
 
div.body h2,
 
div.body h3,
 
div.body h4,
 
div.body h5,
 
div.body h6 {
 
    font-family: Arial, sans-serif;
 
    background-color: #BED4EB;
 
    font-weight: normal;
 
    color: #212224;
 
    margin: 30px 0px 10px 0px;
 
    padding: 5px 0 5px 10px;
 
    text-shadow: 0px 1px 0 white
 
}
 
 
 
div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
 
div.body h2 { font-size: 150%; background-color: #C8D5E3; }
 
div.body h3 { font-size: 120%; background-color: #D8DEE3; }
 
div.body h4 { font-size: 110%; background-color: #D8DEE3; }
 
div.body h5 { font-size: 100%; background-color: #D8DEE3; }
 
div.body h6 { font-size: 100%; background-color: #D8DEE3; }
 
 
 
a.headerlink {
 
    color: #c60f0f;
 
    font-size: 0.8em;
 
    padding: 0 4px 0 4px;
 
    text-decoration: none;
 
}
 
 
 
a.headerlink:hover {
 
    background-color: #c60f0f;
 
    color: white;
 
}
 
 
 
div.body p, div.body dd, div.body li {
 
    line-height: 1.5em;
 
}
 
 
 
div.admonition p.admonition-title + p {
 
    display: inline;
 
}
 

	
 
div.highlight{
 
    background-color: white;
 
}
 

	
 
div.note {
 
    background-color: #eee;
 
    border: 1px solid #ccc;
 
}
 
 
 
div.seealso {
 
    background-color: #ffc;
 
    border: 1px solid #ff6;
 
}
 
 
 
div.topic {
 
    background-color: #eee;
 
}
 
 
 
div.warning {
 
    background-color: #ffe4e4;
 
    border: 1px solid #f66;
 
}
 
 
 
p.admonition-title {
 
    display: inline;
 
}
 
 
 
p.admonition-title:after {
 
    content: ":";
 
}
 
 
 
pre {
 
    padding: 10px;
 
    background-color: White;
 
    color: #222;
 
    line-height: 1.2em;
 
    border: 1px solid #C6C9CB;
 
    font-size: 1.2em;
 
    margin: 1.5em 0 1.5em 0;
 
    -webkit-box-shadow: 1px 1px 1px #d8d8d8;
 
    -moz-box-shadow: 1px 1px 1px #d8d8d8;
 
}
 
 
 
tt {
 
    background-color: #ecf0f3;
 
    color: #222;
 
    padding: 1px 2px;
 
    font-size: 1.2em;
 
    font-family: monospace;
 
}
docs/theme/nature/static/pygments.css
Show inline comments
 
new file 100644
 
.c { color: #999988; font-style: italic } /* Comment */
 
.k { font-weight: bold } /* Keyword */
 
.o { font-weight: bold } /* Operator */
 
.cm { color: #999988; font-style: italic } /* Comment.Multiline */
 
.cp { color: #999999; font-weight: bold } /* Comment.preproc */
 
.c1 { color: #999988; font-style: italic } /* Comment.Single */
 
.gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
 
.ge { font-style: italic } /* Generic.Emph */
 
.gr { color: #aa0000 } /* Generic.Error */
 
.gh { color: #999999 } /* Generic.Heading */
 
.gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
 
.go { color: #111 } /* Generic.Output */
 
.gp { color: #555555 } /* Generic.Prompt */
 
.gs { font-weight: bold } /* Generic.Strong */
 
.gu { color: #aaaaaa } /* Generic.Subheading */
 
.gt { color: #aa0000 } /* Generic.Traceback */
 
.kc { font-weight: bold } /* Keyword.Constant */
 
.kd { font-weight: bold } /* Keyword.Declaration */
 
.kp { font-weight: bold } /* Keyword.Pseudo */
 
.kr { font-weight: bold } /* Keyword.Reserved */
 
.kt { color: #445588; font-weight: bold } /* Keyword.Type */
 
.m { color: #009999 } /* Literal.Number */
 
.s { color: #bb8844 } /* Literal.String */
 
.na { color: #008080 } /* Name.Attribute */
 
.nb { color: #999999 } /* Name.Builtin */
 
.nc { color: #445588; font-weight: bold } /* Name.Class */
 
.no { color: #ff99ff } /* Name.Constant */
 
.ni { color: #800080 } /* Name.Entity */
 
.ne { color: #990000; font-weight: bold } /* Name.Exception */
 
.nf { color: #990000; font-weight: bold } /* Name.Function */
 
.nn { color: #555555 } /* Name.Namespace */
 
.nt { color: #000080 } /* Name.Tag */
 
.nv { color: purple } /* Name.Variable */
 
.ow { font-weight: bold } /* Operator.Word */
 
.mf { color: #009999 } /* Literal.Number.Float */
 
.mh { color: #009999 } /* Literal.Number.Hex */
 
.mi { color: #009999 } /* Literal.Number.Integer */
 
.mo { color: #009999 } /* Literal.Number.Oct */
 
.sb { color: #bb8844 } /* Literal.String.Backtick */
 
.sc { color: #bb8844 } /* Literal.String.Char */
 
.sd { color: #bb8844 } /* Literal.String.Doc */
 
.s2 { color: #bb8844 } /* Literal.String.Double */
 
.se { color: #bb8844 } /* Literal.String.Escape */
 
.sh { color: #bb8844 } /* Literal.String.Heredoc */
 
.si { color: #bb8844 } /* Literal.String.Interpol */
 
.sx { color: #bb8844 } /* Literal.String.Other */
 
.sr { color: #808000 } /* Literal.String.Regex */
 
.s1 { color: #bb8844 } /* Literal.String.Single */
 
.ss { color: #bb8844 } /* Literal.String.Symbol */
 
.bp { color: #999999 } /* Name.Builtin.Pseudo */
 
.vc { color: #ff99ff } /* Name.Variable.Class */
 
.vg { color: #ff99ff } /* Name.Variable.Global */
 
.vi { color: #ff99ff } /* Name.Variable.Instance */
 
.il { color: #009999 } /* Literal.Number.Integer.Long */
 
\ No newline at end of file
docs/theme/nature/theme.conf
Show inline comments
 
new file 100644
 
[theme]
 
inherit = basic
 
stylesheet = nature.css
 
pygments_style = tango
0 comments (0 inline, 0 general)