Show More
@@ -0,0 +1,130 b'' | |||||
|
1 | # Makefile for Sphinx documentation | |||
|
2 | # | |||
|
3 | ||||
|
4 | # You can set these variables from the command line. | |||
|
5 | SPHINXOPTS = | |||
|
6 | SPHINXBUILD = sphinx-build | |||
|
7 | PAPER = | |||
|
8 | BUILDDIR = _build | |||
|
9 | ||||
|
10 | # Internal variables. | |||
|
11 | PAPEROPT_a4 = -D latex_paper_size=a4 | |||
|
12 | PAPEROPT_letter = -D latex_paper_size=letter | |||
|
13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | |||
|
14 | ||||
|
15 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest | |||
|
16 | ||||
|
17 | help: | |||
|
18 | @echo "Please use \`make <target>' where <target> is one of" | |||
|
19 | @echo " html to make standalone HTML files" | |||
|
20 | @echo " dirhtml to make HTML files named index.html in directories" | |||
|
21 | @echo " singlehtml to make a single large HTML file" | |||
|
22 | @echo " pickle to make pickle files" | |||
|
23 | @echo " json to make JSON files" | |||
|
24 | @echo " htmlhelp to make HTML files and a HTML help project" | |||
|
25 | @echo " qthelp to make HTML files and a qthelp project" | |||
|
26 | @echo " devhelp to make HTML files and a Devhelp project" | |||
|
27 | @echo " epub to make an epub" | |||
|
28 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | |||
|
29 | @echo " latexpdf to make LaTeX files and run them through pdflatex" | |||
|
30 | @echo " text to make text files" | |||
|
31 | @echo " man to make manual pages" | |||
|
32 | @echo " changes to make an overview of all changed/added/deprecated items" | |||
|
33 | @echo " linkcheck to check all external links for integrity" | |||
|
34 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" | |||
|
35 | ||||
|
36 | clean: | |||
|
37 | -rm -rf $(BUILDDIR)/* | |||
|
38 | ||||
|
39 | html: | |||
|
40 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | |||
|
41 | @echo | |||
|
42 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | |||
|
43 | ||||
|
44 | dirhtml: | |||
|
45 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | |||
|
46 | @echo | |||
|
47 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | |||
|
48 | ||||
|
49 | singlehtml: | |||
|
50 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | |||
|
51 | @echo | |||
|
52 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | |||
|
53 | ||||
|
54 | pickle: | |||
|
55 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | |||
|
56 | @echo | |||
|
57 | @echo "Build finished; now you can process the pickle files." | |||
|
58 | ||||
|
59 | json: | |||
|
60 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | |||
|
61 | @echo | |||
|
62 | @echo "Build finished; now you can process the JSON files." | |||
|
63 | ||||
|
64 | htmlhelp: | |||
|
65 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | |||
|
66 | @echo | |||
|
67 | @echo "Build finished; now you can run HTML Help Workshop with the" \ | |||
|
68 | ".hhp project file in $(BUILDDIR)/htmlhelp." | |||
|
69 | ||||
|
70 | qthelp: | |||
|
71 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | |||
|
72 | @echo | |||
|
73 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | |||
|
74 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | |||
|
75 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RhodeCode.qhcp" | |||
|
76 | @echo "To view the help file:" | |||
|
77 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RhodeCode.qhc" | |||
|
78 | ||||
|
79 | devhelp: | |||
|
80 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | |||
|
81 | @echo | |||
|
82 | @echo "Build finished." | |||
|
83 | @echo "To view the help file:" | |||
|
84 | @echo "# mkdir -p $$HOME/.local/share/devhelp/RhodeCode" | |||
|
85 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RhodeCode" | |||
|
86 | @echo "# devhelp" | |||
|
87 | ||||
|
88 | epub: | |||
|
89 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | |||
|
90 | @echo | |||
|
91 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | |||
|
92 | ||||
|
93 | latex: | |||
|
94 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |||
|
95 | @echo | |||
|
96 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | |||
|
97 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ | |||
|
98 | "(use \`make latexpdf' here to do that automatically)." | |||
|
99 | ||||
|
100 | latexpdf: | |||
|
101 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |||
|
102 | @echo "Running LaTeX files through pdflatex..." | |||
|
103 | make -C $(BUILDDIR)/latex all-pdf | |||
|
104 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | |||
|
105 | ||||
|
106 | text: | |||
|
107 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | |||
|
108 | @echo | |||
|
109 | @echo "Build finished. The text files are in $(BUILDDIR)/text." | |||
|
110 | ||||
|
111 | man: | |||
|
112 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | |||
|
113 | @echo | |||
|
114 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | |||
|
115 | ||||
|
116 | changes: | |||
|
117 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | |||
|
118 | @echo | |||
|
119 | @echo "The overview file is in $(BUILDDIR)/changes." | |||
|
120 | ||||
|
121 | linkcheck: | |||
|
122 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | |||
|
123 | @echo | |||
|
124 | @echo "Link check complete; look for any errors in the above output " \ | |||
|
125 | "or in $(BUILDDIR)/linkcheck/output.txt." | |||
|
126 | ||||
|
127 | doctest: | |||
|
128 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | |||
|
129 | @echo "Testing of doctests in the sources finished, look at the " \ | |||
|
130 | "results in $(BUILDDIR)/doctest/output.txt." |
@@ -0,0 +1,220 b'' | |||||
|
1 | # -*- coding: utf-8 -*- | |||
|
2 | # | |||
|
3 | # RhodeCode documentation build configuration file, created by | |||
|
4 | # sphinx-quickstart on Sun Oct 10 16:46:37 2010. | |||
|
5 | # | |||
|
6 | # This file is execfile()d with the current directory set to its containing dir. | |||
|
7 | # | |||
|
8 | # Note that not all possible configuration values are present in this | |||
|
9 | # autogenerated file. | |||
|
10 | # | |||
|
11 | # All configuration values have a default; values that are commented out | |||
|
12 | # serve to show the default. | |||
|
13 | ||||
|
14 | import sys, os | |||
|
15 | ||||
|
16 | # If extensions (or modules to document with autodoc) are in another directory, | |||
|
17 | # add these directories to sys.path here. If the directory is relative to the | |||
|
18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | |||
|
19 | #sys.path.insert(0, os.path.abspath('.')) | |||
|
20 | ||||
|
21 | # -- General configuration ----------------------------------------------------- | |||
|
22 | ||||
|
23 | # If your documentation needs a minimal Sphinx version, state it here. | |||
|
24 | #needs_sphinx = '1.0' | |||
|
25 | ||||
|
26 | # Add any Sphinx extension module names here, as strings. They can be extensions | |||
|
27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | |||
|
28 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode'] | |||
|
29 | ||||
|
30 | # Add any paths that contain templates here, relative to this directory. | |||
|
31 | templates_path = ['_templates'] | |||
|
32 | ||||
|
33 | # The suffix of source filenames. | |||
|
34 | source_suffix = '.rst' | |||
|
35 | ||||
|
36 | # The encoding of source files. | |||
|
37 | #source_encoding = 'utf-8-sig' | |||
|
38 | ||||
|
39 | # The master toctree document. | |||
|
40 | master_doc = 'index' | |||
|
41 | ||||
|
42 | # General information about the project. | |||
|
43 | project = u'RhodeCode' | |||
|
44 | copyright = u'2010, Marcin Kuzminski' | |||
|
45 | ||||
|
46 | # The version info for the project you're documenting, acts as replacement for | |||
|
47 | # |version| and |release|, also used in various other places throughout the | |||
|
48 | # built documents. | |||
|
49 | # | |||
|
50 | # The short X.Y version. | |||
|
51 | version = '1.0.0' | |||
|
52 | # The full version, including alpha/beta/rc tags. | |||
|
53 | release = '1.0.0rc1' | |||
|
54 | ||||
|
55 | # The language for content autogenerated by Sphinx. Refer to documentation | |||
|
56 | # for a list of supported languages. | |||
|
57 | #language = None | |||
|
58 | ||||
|
59 | # There are two options for replacing |today|: either, you set today to some | |||
|
60 | # non-false value, then it is used: | |||
|
61 | #today = '' | |||
|
62 | # Else, today_fmt is used as the format for a strftime call. | |||
|
63 | #today_fmt = '%B %d, %Y' | |||
|
64 | ||||
|
65 | # List of patterns, relative to source directory, that match files and | |||
|
66 | # directories to ignore when looking for source files. | |||
|
67 | exclude_patterns = ['_build'] | |||
|
68 | ||||
|
69 | # The reST default role (used for this markup: `text`) to use for all documents. | |||
|
70 | #default_role = None | |||
|
71 | ||||
|
72 | # If true, '()' will be appended to :func: etc. cross-reference text. | |||
|
73 | #add_function_parentheses = True | |||
|
74 | ||||
|
75 | # If true, the current module name will be prepended to all description | |||
|
76 | # unit titles (such as .. function::). | |||
|
77 | #add_module_names = True | |||
|
78 | ||||
|
79 | # If true, sectionauthor and moduleauthor directives will be shown in the | |||
|
80 | # output. They are ignored by default. | |||
|
81 | #show_authors = False | |||
|
82 | ||||
|
83 | # The name of the Pygments (syntax highlighting) style to use. | |||
|
84 | pygments_style = 'sphinx' | |||
|
85 | ||||
|
86 | # A list of ignored prefixes for module index sorting. | |||
|
87 | #modindex_common_prefix = [] | |||
|
88 | ||||
|
89 | ||||
|
90 | # -- Options for HTML output --------------------------------------------------- | |||
|
91 | ||||
|
92 | # The theme to use for HTML and HTML Help pages. See the documentation for | |||
|
93 | # a list of builtin themes. | |||
|
94 | html_theme = 'nature' | |||
|
95 | ||||
|
96 | # Theme options are theme-specific and customize the look and feel of a theme | |||
|
97 | # further. For a list of options available for each theme, see the | |||
|
98 | # documentation. | |||
|
99 | #html_theme_options = {} | |||
|
100 | ||||
|
101 | # Add any paths that contain custom themes here, relative to this directory. | |||
|
102 | html_theme_path = ['theme'] | |||
|
103 | ||||
|
104 | # The name for this set of Sphinx documents. If None, it defaults to | |||
|
105 | # "<project> v<release> documentation". | |||
|
106 | #html_title = None | |||
|
107 | ||||
|
108 | # A shorter title for the navigation bar. Default is the same as html_title. | |||
|
109 | #html_short_title = None | |||
|
110 | ||||
|
111 | # The name of an image file (relative to this directory) to place at the top | |||
|
112 | # of the sidebar. | |||
|
113 | #html_logo = None | |||
|
114 | ||||
|
115 | # The name of an image file (within the static path) to use as favicon of the | |||
|
116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | |||
|
117 | # pixels large. | |||
|
118 | #html_favicon = None | |||
|
119 | ||||
|
120 | # Add any paths that contain custom static files (such as style sheets) here, | |||
|
121 | # relative to this directory. They are copied after the builtin static files, | |||
|
122 | # so a file named "default.css" will overwrite the builtin "default.css". | |||
|
123 | html_static_path = ['_static'] | |||
|
124 | ||||
|
125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | |||
|
126 | # using the given strftime format. | |||
|
127 | #html_last_updated_fmt = '%b %d, %Y' | |||
|
128 | ||||
|
129 | # If true, SmartyPants will be used to convert quotes and dashes to | |||
|
130 | # typographically correct entities. | |||
|
131 | #html_use_smartypants = True | |||
|
132 | ||||
|
133 | # Custom sidebar templates, maps document names to template names. | |||
|
134 | #html_sidebars = {} | |||
|
135 | ||||
|
136 | # Additional templates that should be rendered to pages, maps page names to | |||
|
137 | # template names. | |||
|
138 | #html_additional_pages = {} | |||
|
139 | ||||
|
140 | # If false, no module index is generated. | |||
|
141 | #html_domain_indices = True | |||
|
142 | ||||
|
143 | # If false, no index is generated. | |||
|
144 | #html_use_index = True | |||
|
145 | ||||
|
146 | # If true, the index is split into individual pages for each letter. | |||
|
147 | #html_split_index = False | |||
|
148 | ||||
|
149 | # If true, links to the reST sources are added to the pages. | |||
|
150 | #html_show_sourcelink = True | |||
|
151 | ||||
|
152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | |||
|
153 | #html_show_sphinx = True | |||
|
154 | ||||
|
155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | |||
|
156 | #html_show_copyright = True | |||
|
157 | ||||
|
158 | # If true, an OpenSearch description file will be output, and all pages will | |||
|
159 | # contain a <link> tag referring to it. The value of this option must be the | |||
|
160 | # base URL from which the finished HTML is served. | |||
|
161 | #html_use_opensearch = '' | |||
|
162 | ||||
|
163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | |||
|
164 | #html_file_suffix = None | |||
|
165 | ||||
|
166 | # Output file base name for HTML help builder. | |||
|
167 | htmlhelp_basename = 'RhodeCodedoc' | |||
|
168 | ||||
|
169 | ||||
|
170 | # -- Options for LaTeX output -------------------------------------------------- | |||
|
171 | ||||
|
172 | # The paper size ('letter' or 'a4'). | |||
|
173 | #latex_paper_size = 'letter' | |||
|
174 | ||||
|
175 | # The font size ('10pt', '11pt' or '12pt'). | |||
|
176 | #latex_font_size = '10pt' | |||
|
177 | ||||
|
178 | # Grouping the document tree into LaTeX files. List of tuples | |||
|
179 | # (source start file, target name, title, author, documentclass [howto/manual]). | |||
|
180 | latex_documents = [ | |||
|
181 | ('index', 'RhodeCode.tex', u'RhodeCode Documentation', | |||
|
182 | u'Marcin Kuzminski', 'manual'), | |||
|
183 | ] | |||
|
184 | ||||
|
185 | # The name of an image file (relative to this directory) to place at the top of | |||
|
186 | # the title page. | |||
|
187 | #latex_logo = None | |||
|
188 | ||||
|
189 | # For "manual" documents, if this is true, then toplevel headings are parts, | |||
|
190 | # not chapters. | |||
|
191 | #latex_use_parts = False | |||
|
192 | ||||
|
193 | # If true, show page references after internal links. | |||
|
194 | #latex_show_pagerefs = False | |||
|
195 | ||||
|
196 | # If true, show URL addresses after external links. | |||
|
197 | #latex_show_urls = False | |||
|
198 | ||||
|
199 | # Additional stuff for the LaTeX preamble. | |||
|
200 | #latex_preamble = '' | |||
|
201 | ||||
|
202 | # Documents to append as an appendix to all manuals. | |||
|
203 | #latex_appendices = [] | |||
|
204 | ||||
|
205 | # If false, no module index is generated. | |||
|
206 | #latex_domain_indices = True | |||
|
207 | ||||
|
208 | ||||
|
209 | # -- Options for manual page output -------------------------------------------- | |||
|
210 | ||||
|
211 | # One entry per manual page. List of tuples | |||
|
212 | # (source start file, name, description, authors, manual section). | |||
|
213 | man_pages = [ | |||
|
214 | ('index', 'rhodecode', u'RhodeCode Documentation', | |||
|
215 | [u'Marcin Kuzminski'], 1) | |||
|
216 | ] | |||
|
217 | ||||
|
218 | ||||
|
219 | # Example configuration for intersphinx: refer to the Python standard library. | |||
|
220 | intersphinx_mapping = {'http://docs.python.org/': None} |
1 | NO CONTENT: new file 100644, binary diff hidden |
|
NO CONTENT: new file 100644, binary diff hidden |
1 | NO CONTENT: new file 100644, binary diff hidden |
|
NO CONTENT: new file 100644, binary diff hidden |
@@ -0,0 +1,95 b'' | |||||
|
1 | .. _installation: | |||
|
2 | ||||
|
3 | Installation | |||
|
4 | ============ | |||
|
5 | ||||
|
6 | ``RhodeCode`` is written entirely in Python, but in order to use it's full | |||
|
7 | potential there are some third-party requirements. When RhodeCode is used | |||
|
8 | together with celery You have to install some kind of message broker, | |||
|
9 | recommended one is rabbitmq to make the async tasks work. | |||
|
10 | For installation instructions You can visit: | |||
|
11 | http://ask.github.com/celery/getting-started/index.html. | |||
|
12 | ||||
|
13 | Of course RhodeCode works in sync mode also, then You don't have to install | |||
|
14 | any third party apps. Celery will give You large speed improvement when using | |||
|
15 | many big repositories. If You plan to use it for 2 or 3 small repositories, it | |||
|
16 | will work just fine without celery running. | |||
|
17 | ||||
|
18 | After You decide to Run it with celery make sure You run celeryd and | |||
|
19 | message broker together with the application. | |||
|
20 | ||||
|
21 | Requirements for Celery | |||
|
22 | ----------------------- | |||
|
23 | ||||
|
24 | **Message Broker** | |||
|
25 | ||||
|
26 | - preferred is `RabbitMq <http://www.rabbitmq.com/>`_ | |||
|
27 | - possible other is `Redis <http://code.google.com/p/redis/>`_ | |||
|
28 | ||||
|
29 | ||||
|
30 | Install from Cheese Shop | |||
|
31 | ------------------------ | |||
|
32 | ||||
|
33 | Easiest way to install ``rhodecode`` is to run:: | |||
|
34 | ||||
|
35 | easy_install rhodecode | |||
|
36 | ||||
|
37 | Or:: | |||
|
38 | ||||
|
39 | pip install rhodecode | |||
|
40 | ||||
|
41 | If you prefer to install manually simply grab latest release from | |||
|
42 | http://pypi.python.org/pypi/rhodecode, decompres archive and run:: | |||
|
43 | ||||
|
44 | python setup.py install | |||
|
45 | ||||
|
46 | ||||
|
47 | **Setting up the application** | |||
|
48 | I recommend to run the RhodeCode in separate virtualenv. | |||
|
49 | See http://pypi.python.org/pypi/virtualenv for more details. | |||
|
50 | ||||
|
51 | - run `paster make-config RhodeCode production.ini` make specific application | |||
|
52 | config, | |||
|
53 | - run `paster setup-app production.ini` makes the database, and propagates it | |||
|
54 | with default data, In this step You have to provide admin username and repositories | |||
|
55 | location, it can be a new location or with existing ones in that case RhodeCode | |||
|
56 | will scann all new found repos and put it into database. | |||
|
57 | - run `paster runserver production.ini` runs the server. | |||
|
58 | ||||
|
59 | ||||
|
60 | **STEP BY STEP EXAMPLE INSTRUCTION** | |||
|
61 | ||||
|
62 | ||||
|
63 | - Assuming You have setup virtualenv create one using | |||
|
64 | `virtualenv --no-site-packages /var/www/rhodecode-venv` | |||
|
65 | this will install new virtual env into /var/www/rhodecode-venv. | |||
|
66 | - Activate the virtualenv by running | |||
|
67 | `source activate /var/www/rhodecode-venv/bin/activate` | |||
|
68 | - Make a folder for rhodecode somewhere on the filesystem for example | |||
|
69 | /var/www/rhodecode | |||
|
70 | - Run easy_install rhodecode, this will install rhodecode together with pylons | |||
|
71 | and all other required python libraries | |||
|
72 | - Run `paster make-config RhodeCode production.ini` in order to install | |||
|
73 | the application config. | |||
|
74 | - Run `paster setup-app production.ini` it should create all needed tables | |||
|
75 | and an admin account. Also make sure You specify correct path to repositories. | |||
|
76 | You can either use a new location of one with already exising ones. RhodeCode | |||
|
77 | will simply add all new found repositories to it's database. | |||
|
78 | - Remember that the given path for mercurial repositories must be write | |||
|
79 | accessible for the application. It's very important since RhodeCode web interface | |||
|
80 | will work even without such an access but, when trying to do a push it's eventually | |||
|
81 | failed with permission denied. | |||
|
82 | - Run `paster serve production.ini` | |||
|
83 | the app should be available at the 127.0.0.1:5000 | |||
|
84 | - Use admin account you created to login. | |||
|
85 | - Default permissions on each repository is read, and owner is admin. So remember | |||
|
86 | to update these. | |||
|
87 | ||||
|
88 | - All needed configs are inside rhodecode sources ie. celeryconfig.py, | |||
|
89 | development.ini, production.ini You can configure the email, ports, loggers, | |||
|
90 | workers from there. | |||
|
91 | - For full text search You can either put crontab entry for | |||
|
92 | `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>` | |||
|
93 | or run indexer from admin panel. This will scann the repos given in the | |||
|
94 | application setup or given path for daemon.py and each scann in incremental | |||
|
95 | mode will scan only changed files. No newline at end of file |
@@ -0,0 +1,155 b'' | |||||
|
1 | @ECHO OFF | |||
|
2 | ||||
|
3 | REM Command file for Sphinx documentation | |||
|
4 | ||||
|
5 | if "%SPHINXBUILD%" == "" ( | |||
|
6 | set SPHINXBUILD=sphinx-build | |||
|
7 | ) | |||
|
8 | set BUILDDIR=_build | |||
|
9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . | |||
|
10 | if NOT "%PAPER%" == "" ( | |||
|
11 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% | |||
|
12 | ) | |||
|
13 | ||||
|
14 | if "%1" == "" goto help | |||
|
15 | ||||
|
16 | if "%1" == "help" ( | |||
|
17 | :help | |||
|
18 | echo.Please use `make ^<target^>` where ^<target^> is one of | |||
|
19 | echo. html to make standalone HTML files | |||
|
20 | echo. dirhtml to make HTML files named index.html in directories | |||
|
21 | echo. singlehtml to make a single large HTML file | |||
|
22 | echo. pickle to make pickle files | |||
|
23 | echo. json to make JSON files | |||
|
24 | echo. htmlhelp to make HTML files and a HTML help project | |||
|
25 | echo. qthelp to make HTML files and a qthelp project | |||
|
26 | echo. devhelp to make HTML files and a Devhelp project | |||
|
27 | echo. epub to make an epub | |||
|
28 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter | |||
|
29 | echo. text to make text files | |||
|
30 | echo. man to make manual pages | |||
|
31 | echo. changes to make an overview over all changed/added/deprecated items | |||
|
32 | echo. linkcheck to check all external links for integrity | |||
|
33 | echo. doctest to run all doctests embedded in the documentation if enabled | |||
|
34 | goto end | |||
|
35 | ) | |||
|
36 | ||||
|
37 | if "%1" == "clean" ( | |||
|
38 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i | |||
|
39 | del /q /s %BUILDDIR%\* | |||
|
40 | goto end | |||
|
41 | ) | |||
|
42 | ||||
|
43 | if "%1" == "html" ( | |||
|
44 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html | |||
|
45 | echo. | |||
|
46 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. | |||
|
47 | goto end | |||
|
48 | ) | |||
|
49 | ||||
|
50 | if "%1" == "dirhtml" ( | |||
|
51 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml | |||
|
52 | echo. | |||
|
53 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. | |||
|
54 | goto end | |||
|
55 | ) | |||
|
56 | ||||
|
57 | if "%1" == "singlehtml" ( | |||
|
58 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml | |||
|
59 | echo. | |||
|
60 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. | |||
|
61 | goto end | |||
|
62 | ) | |||
|
63 | ||||
|
64 | if "%1" == "pickle" ( | |||
|
65 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle | |||
|
66 | echo. | |||
|
67 | echo.Build finished; now you can process the pickle files. | |||
|
68 | goto end | |||
|
69 | ) | |||
|
70 | ||||
|
71 | if "%1" == "json" ( | |||
|
72 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json | |||
|
73 | echo. | |||
|
74 | echo.Build finished; now you can process the JSON files. | |||
|
75 | goto end | |||
|
76 | ) | |||
|
77 | ||||
|
78 | if "%1" == "htmlhelp" ( | |||
|
79 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp | |||
|
80 | echo. | |||
|
81 | echo.Build finished; now you can run HTML Help Workshop with the ^ | |||
|
82 | .hhp project file in %BUILDDIR%/htmlhelp. | |||
|
83 | goto end | |||
|
84 | ) | |||
|
85 | ||||
|
86 | if "%1" == "qthelp" ( | |||
|
87 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp | |||
|
88 | echo. | |||
|
89 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ | |||
|
90 | .qhcp project file in %BUILDDIR%/qthelp, like this: | |||
|
91 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\RhodeCode.qhcp | |||
|
92 | echo.To view the help file: | |||
|
93 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\RhodeCode.ghc | |||
|
94 | goto end | |||
|
95 | ) | |||
|
96 | ||||
|
97 | if "%1" == "devhelp" ( | |||
|
98 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp | |||
|
99 | echo. | |||
|
100 | echo.Build finished. | |||
|
101 | goto end | |||
|
102 | ) | |||
|
103 | ||||
|
104 | if "%1" == "epub" ( | |||
|
105 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub | |||
|
106 | echo. | |||
|
107 | echo.Build finished. The epub file is in %BUILDDIR%/epub. | |||
|
108 | goto end | |||
|
109 | ) | |||
|
110 | ||||
|
111 | if "%1" == "latex" ( | |||
|
112 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | |||
|
113 | echo. | |||
|
114 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. | |||
|
115 | goto end | |||
|
116 | ) | |||
|
117 | ||||
|
118 | if "%1" == "text" ( | |||
|
119 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text | |||
|
120 | echo. | |||
|
121 | echo.Build finished. The text files are in %BUILDDIR%/text. | |||
|
122 | goto end | |||
|
123 | ) | |||
|
124 | ||||
|
125 | if "%1" == "man" ( | |||
|
126 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man | |||
|
127 | echo. | |||
|
128 | echo.Build finished. The manual pages are in %BUILDDIR%/man. | |||
|
129 | goto end | |||
|
130 | ) | |||
|
131 | ||||
|
132 | if "%1" == "changes" ( | |||
|
133 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes | |||
|
134 | echo. | |||
|
135 | echo.The overview file is in %BUILDDIR%/changes. | |||
|
136 | goto end | |||
|
137 | ) | |||
|
138 | ||||
|
139 | if "%1" == "linkcheck" ( | |||
|
140 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck | |||
|
141 | echo. | |||
|
142 | echo.Link check complete; look for any errors in the above output ^ | |||
|
143 | or in %BUILDDIR%/linkcheck/output.txt. | |||
|
144 | goto end | |||
|
145 | ) | |||
|
146 | ||||
|
147 | if "%1" == "doctest" ( | |||
|
148 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest | |||
|
149 | echo. | |||
|
150 | echo.Testing of doctests in the sources finished, look at the ^ | |||
|
151 | results in %BUILDDIR%/doctest/output.txt. | |||
|
152 | goto end | |||
|
153 | ) | |||
|
154 | ||||
|
155 | :end |
@@ -0,0 +1,16 b'' | |||||
|
1 | .. _setup: | |||
|
2 | ||||
|
3 | Setup | |||
|
4 | ===== | |||
|
5 | ||||
|
6 | ||||
|
7 | - All needed configs are inside rhodecode sources ie. celeryconfig.py, | |||
|
8 | development.ini, production.ini You can configure the email, ports, loggers, | |||
|
9 | workers from there. | |||
|
10 | - For full text search You can either put crontab entry for | |||
|
11 | `python /var/www/rhodecode/rhodecode/lib/indexers/daemon.py incremental <path_to_repos>` | |||
|
12 | or run indexer from admin panel. This will scann the repos given in the | |||
|
13 | application setup or given path for daemon.py and each scann in incremental | |||
|
14 | mode will scan only changed files. | |||
|
15 | ||||
|
16 | TODO: write that ! No newline at end of file |
@@ -0,0 +1,229 b'' | |||||
|
1 | /** | |||
|
2 | * Sphinx stylesheet -- default theme | |||
|
3 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |||
|
4 | */ | |||
|
5 | ||||
|
6 | @import url("basic.css"); | |||
|
7 | ||||
|
8 | /* -- page layout ----------------------------------------------------------- */ | |||
|
9 | ||||
|
10 | body { | |||
|
11 | font-family: Arial, sans-serif; | |||
|
12 | font-size: 100%; | |||
|
13 | background-color: #111; | |||
|
14 | color: #555; | |||
|
15 | margin: 0; | |||
|
16 | padding: 0; | |||
|
17 | } | |||
|
18 | ||||
|
19 | div.documentwrapper { | |||
|
20 | float: left; | |||
|
21 | width: 100%; | |||
|
22 | } | |||
|
23 | ||||
|
24 | div.bodywrapper { | |||
|
25 | margin: 0 0 0 230px; | |||
|
26 | } | |||
|
27 | ||||
|
28 | hr{ | |||
|
29 | border: 1px solid #B1B4B6; | |||
|
30 | } | |||
|
31 | ||||
|
32 | div.document { | |||
|
33 | background-color: #eee; | |||
|
34 | } | |||
|
35 | ||||
|
36 | div.body { | |||
|
37 | background-color: #ffffff; | |||
|
38 | color: #3E4349; | |||
|
39 | padding: 0 30px 30px 30px; | |||
|
40 | font-size: 0.8em; | |||
|
41 | } | |||
|
42 | ||||
|
43 | div.footer { | |||
|
44 | color: #555; | |||
|
45 | width: 100%; | |||
|
46 | padding: 13px 0; | |||
|
47 | text-align: center; | |||
|
48 | font-size: 75%; | |||
|
49 | } | |||
|
50 | ||||
|
51 | div.footer a { | |||
|
52 | color: #444; | |||
|
53 | text-decoration: underline; | |||
|
54 | } | |||
|
55 | ||||
|
56 | div.related { | |||
|
57 | background-color: #6BA81E; | |||
|
58 | line-height: 32px; | |||
|
59 | color: #fff; | |||
|
60 | text-shadow: 0px 1px 0 #444; | |||
|
61 | font-size: 0.80em; | |||
|
62 | } | |||
|
63 | ||||
|
64 | div.related a { | |||
|
65 | color: #E2F3CC; | |||
|
66 | } | |||
|
67 | ||||
|
68 | div.sphinxsidebar { | |||
|
69 | font-size: 0.75em; | |||
|
70 | line-height: 1.5em; | |||
|
71 | } | |||
|
72 | ||||
|
73 | div.sphinxsidebarwrapper{ | |||
|
74 | padding: 20px 0; | |||
|
75 | } | |||
|
76 | ||||
|
77 | div.sphinxsidebar h3, | |||
|
78 | div.sphinxsidebar h4 { | |||
|
79 | font-family: Arial, sans-serif; | |||
|
80 | color: #222; | |||
|
81 | font-size: 1.2em; | |||
|
82 | font-weight: normal; | |||
|
83 | margin: 0; | |||
|
84 | padding: 5px 10px; | |||
|
85 | background-color: #ddd; | |||
|
86 | text-shadow: 1px 1px 0 white | |||
|
87 | } | |||
|
88 | ||||
|
89 | div.sphinxsidebar h4{ | |||
|
90 | font-size: 1.1em; | |||
|
91 | } | |||
|
92 | ||||
|
93 | div.sphinxsidebar h3 a { | |||
|
94 | color: #444; | |||
|
95 | } | |||
|
96 | ||||
|
97 | ||||
|
98 | div.sphinxsidebar p { | |||
|
99 | color: #888; | |||
|
100 | padding: 5px 20px; | |||
|
101 | } | |||
|
102 | ||||
|
103 | div.sphinxsidebar p.topless { | |||
|
104 | } | |||
|
105 | ||||
|
106 | div.sphinxsidebar ul { | |||
|
107 | margin: 10px 20px; | |||
|
108 | padding: 0; | |||
|
109 | color: #000; | |||
|
110 | } | |||
|
111 | ||||
|
112 | div.sphinxsidebar a { | |||
|
113 | color: #444; | |||
|
114 | } | |||
|
115 | ||||
|
116 | div.sphinxsidebar input { | |||
|
117 | border: 1px solid #ccc; | |||
|
118 | font-family: sans-serif; | |||
|
119 | font-size: 1em; | |||
|
120 | } | |||
|
121 | ||||
|
122 | div.sphinxsidebar input[type=text]{ | |||
|
123 | margin-left: 20px; | |||
|
124 | } | |||
|
125 | ||||
|
126 | /* -- body styles ----------------------------------------------------------- */ | |||
|
127 | ||||
|
128 | a { | |||
|
129 | color: #005B81; | |||
|
130 | text-decoration: none; | |||
|
131 | } | |||
|
132 | ||||
|
133 | a:hover { | |||
|
134 | color: #E32E00; | |||
|
135 | text-decoration: underline; | |||
|
136 | } | |||
|
137 | ||||
|
138 | div.body h1, | |||
|
139 | div.body h2, | |||
|
140 | div.body h3, | |||
|
141 | div.body h4, | |||
|
142 | div.body h5, | |||
|
143 | div.body h6 { | |||
|
144 | font-family: Arial, sans-serif; | |||
|
145 | background-color: #BED4EB; | |||
|
146 | font-weight: normal; | |||
|
147 | color: #212224; | |||
|
148 | margin: 30px 0px 10px 0px; | |||
|
149 | padding: 5px 0 5px 10px; | |||
|
150 | text-shadow: 0px 1px 0 white | |||
|
151 | } | |||
|
152 | ||||
|
153 | div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; } | |||
|
154 | div.body h2 { font-size: 150%; background-color: #C8D5E3; } | |||
|
155 | div.body h3 { font-size: 120%; background-color: #D8DEE3; } | |||
|
156 | div.body h4 { font-size: 110%; background-color: #D8DEE3; } | |||
|
157 | div.body h5 { font-size: 100%; background-color: #D8DEE3; } | |||
|
158 | div.body h6 { font-size: 100%; background-color: #D8DEE3; } | |||
|
159 | ||||
|
160 | a.headerlink { | |||
|
161 | color: #c60f0f; | |||
|
162 | font-size: 0.8em; | |||
|
163 | padding: 0 4px 0 4px; | |||
|
164 | text-decoration: none; | |||
|
165 | } | |||
|
166 | ||||
|
167 | a.headerlink:hover { | |||
|
168 | background-color: #c60f0f; | |||
|
169 | color: white; | |||
|
170 | } | |||
|
171 | ||||
|
172 | div.body p, div.body dd, div.body li { | |||
|
173 | line-height: 1.5em; | |||
|
174 | } | |||
|
175 | ||||
|
176 | div.admonition p.admonition-title + p { | |||
|
177 | display: inline; | |||
|
178 | } | |||
|
179 | ||||
|
180 | div.highlight{ | |||
|
181 | background-color: white; | |||
|
182 | } | |||
|
183 | ||||
|
184 | div.note { | |||
|
185 | background-color: #eee; | |||
|
186 | border: 1px solid #ccc; | |||
|
187 | } | |||
|
188 | ||||
|
189 | div.seealso { | |||
|
190 | background-color: #ffc; | |||
|
191 | border: 1px solid #ff6; | |||
|
192 | } | |||
|
193 | ||||
|
194 | div.topic { | |||
|
195 | background-color: #eee; | |||
|
196 | } | |||
|
197 | ||||
|
198 | div.warning { | |||
|
199 | background-color: #ffe4e4; | |||
|
200 | border: 1px solid #f66; | |||
|
201 | } | |||
|
202 | ||||
|
203 | p.admonition-title { | |||
|
204 | display: inline; | |||
|
205 | } | |||
|
206 | ||||
|
207 | p.admonition-title:after { | |||
|
208 | content: ":"; | |||
|
209 | } | |||
|
210 | ||||
|
211 | pre { | |||
|
212 | padding: 10px; | |||
|
213 | background-color: White; | |||
|
214 | color: #222; | |||
|
215 | line-height: 1.2em; | |||
|
216 | border: 1px solid #C6C9CB; | |||
|
217 | font-size: 1.2em; | |||
|
218 | margin: 1.5em 0 1.5em 0; | |||
|
219 | -webkit-box-shadow: 1px 1px 1px #d8d8d8; | |||
|
220 | -moz-box-shadow: 1px 1px 1px #d8d8d8; | |||
|
221 | } | |||
|
222 | ||||
|
223 | tt { | |||
|
224 | background-color: #ecf0f3; | |||
|
225 | color: #222; | |||
|
226 | padding: 1px 2px; | |||
|
227 | font-size: 1.2em; | |||
|
228 | font-family: monospace; | |||
|
229 | } |
@@ -0,0 +1,54 b'' | |||||
|
1 | .c { color: #999988; font-style: italic } /* Comment */ | |||
|
2 | .k { font-weight: bold } /* Keyword */ | |||
|
3 | .o { font-weight: bold } /* Operator */ | |||
|
4 | .cm { color: #999988; font-style: italic } /* Comment.Multiline */ | |||
|
5 | .cp { color: #999999; font-weight: bold } /* Comment.preproc */ | |||
|
6 | .c1 { color: #999988; font-style: italic } /* Comment.Single */ | |||
|
7 | .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ | |||
|
8 | .ge { font-style: italic } /* Generic.Emph */ | |||
|
9 | .gr { color: #aa0000 } /* Generic.Error */ | |||
|
10 | .gh { color: #999999 } /* Generic.Heading */ | |||
|
11 | .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ | |||
|
12 | .go { color: #111 } /* Generic.Output */ | |||
|
13 | .gp { color: #555555 } /* Generic.Prompt */ | |||
|
14 | .gs { font-weight: bold } /* Generic.Strong */ | |||
|
15 | .gu { color: #aaaaaa } /* Generic.Subheading */ | |||
|
16 | .gt { color: #aa0000 } /* Generic.Traceback */ | |||
|
17 | .kc { font-weight: bold } /* Keyword.Constant */ | |||
|
18 | .kd { font-weight: bold } /* Keyword.Declaration */ | |||
|
19 | .kp { font-weight: bold } /* Keyword.Pseudo */ | |||
|
20 | .kr { font-weight: bold } /* Keyword.Reserved */ | |||
|
21 | .kt { color: #445588; font-weight: bold } /* Keyword.Type */ | |||
|
22 | .m { color: #009999 } /* Literal.Number */ | |||
|
23 | .s { color: #bb8844 } /* Literal.String */ | |||
|
24 | .na { color: #008080 } /* Name.Attribute */ | |||
|
25 | .nb { color: #999999 } /* Name.Builtin */ | |||
|
26 | .nc { color: #445588; font-weight: bold } /* Name.Class */ | |||
|
27 | .no { color: #ff99ff } /* Name.Constant */ | |||
|
28 | .ni { color: #800080 } /* Name.Entity */ | |||
|
29 | .ne { color: #990000; font-weight: bold } /* Name.Exception */ | |||
|
30 | .nf { color: #990000; font-weight: bold } /* Name.Function */ | |||
|
31 | .nn { color: #555555 } /* Name.Namespace */ | |||
|
32 | .nt { color: #000080 } /* Name.Tag */ | |||
|
33 | .nv { color: purple } /* Name.Variable */ | |||
|
34 | .ow { font-weight: bold } /* Operator.Word */ | |||
|
35 | .mf { color: #009999 } /* Literal.Number.Float */ | |||
|
36 | .mh { color: #009999 } /* Literal.Number.Hex */ | |||
|
37 | .mi { color: #009999 } /* Literal.Number.Integer */ | |||
|
38 | .mo { color: #009999 } /* Literal.Number.Oct */ | |||
|
39 | .sb { color: #bb8844 } /* Literal.String.Backtick */ | |||
|
40 | .sc { color: #bb8844 } /* Literal.String.Char */ | |||
|
41 | .sd { color: #bb8844 } /* Literal.String.Doc */ | |||
|
42 | .s2 { color: #bb8844 } /* Literal.String.Double */ | |||
|
43 | .se { color: #bb8844 } /* Literal.String.Escape */ | |||
|
44 | .sh { color: #bb8844 } /* Literal.String.Heredoc */ | |||
|
45 | .si { color: #bb8844 } /* Literal.String.Interpol */ | |||
|
46 | .sx { color: #bb8844 } /* Literal.String.Other */ | |||
|
47 | .sr { color: #808000 } /* Literal.String.Regex */ | |||
|
48 | .s1 { color: #bb8844 } /* Literal.String.Single */ | |||
|
49 | .ss { color: #bb8844 } /* Literal.String.Symbol */ | |||
|
50 | .bp { color: #999999 } /* Name.Builtin.Pseudo */ | |||
|
51 | .vc { color: #ff99ff } /* Name.Variable.Class */ | |||
|
52 | .vg { color: #ff99ff } /* Name.Variable.Global */ | |||
|
53 | .vi { color: #ff99ff } /* Name.Variable.Instance */ | |||
|
54 | .il { color: #009999 } /* Literal.Number.Integer.Long */ No newline at end of file |
@@ -1,19 +1,82 b'' | |||||
1 | rhodecode |
|
1 | .. _index: | |
2 | ++++++++++ |
|
2 | ||
|
3 | Welcome to RhodeCode (RhodiumCode) documentation! | |||
|
4 | ================================================= | |||
|
5 | ||||
|
6 | ``RhodeCode`` is Pylons based repository management and serving for mercurial. | |||
|
7 | It's similar to github or bitbucket, but focuses more on closed access restrictions. | |||
|
8 | There's no default free access to RhodeCode You have to create an account in order | |||
|
9 | to use the application. | |||
|
10 | ||||
|
11 | ||||
|
12 | RhodeCode uses `Semantic Versioning <http://semver.org/>`_ | |||
|
13 | ||||
|
14 | **Features** | |||
3 |
|
15 | |||
4 | This is the main index page of your documentation. It should be written in |
|
16 | - Has it's own middleware to handle mercurial protocol request. Each request can | |
5 | `reStructuredText format <http://docutils.sourceforge.net/rst.html>`_. |
|
17 | be logged and authenticated. Runs on threads unlikely to hgweb You can make | |
|
18 | multiple pulls/pushes simultaneous | |||
|
19 | - Full permissions and authentication per project private/read/write/admin. | |||
|
20 | One account for web interface and mercurial push/pull/clone. | |||
|
21 | - Mako templates let's you customize look and feel of application. | |||
|
22 | - Beautiful diffs, annotations and source codes all colored by pygments. | |||
|
23 | - Mercurial branch graph and yui-flot powered graphs with zooming and statistics | |||
|
24 | - Admin interface with user/permission management. User activity journal logs | |||
|
25 | pulls, pushes, forks,registrations. Possible to disable built in hooks | |||
|
26 | - Server side forks, it's possible to fork a project and hack it free without | |||
|
27 | breaking the main. | |||
|
28 | - Full text search on source codes, search on file names. All powered by whoosh | |||
|
29 | and build in indexing daemons | |||
|
30 | (no external search servers required all in one application) | |||
|
31 | - Rss / atom feeds, gravatar support, download sources as zip/tarballs | |||
|
32 | - Async tasks for speed and performance using celery (works without them too) | |||
|
33 | - Backup scripts can do backup of whole app and send it over scp to desired | |||
|
34 | location | |||
|
35 | - Setup project descriptions and info inside built in db for easy, non | |||
|
36 | file-system operations | |||
|
37 | - Added cache with invalidation on push/repo management for high performance and | |||
|
38 | always up to date data. | |||
|
39 | - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite | |||
6 |
|
40 | |||
7 | You can generate your documentation in HTML format by running this command:: |
|
|||
8 |
|
||||
9 | setup.py pudge |
|
|||
10 |
|
41 | |||
11 | For this to work you will need to download and install `buildutils`_, |
|
42 | .. figure:: images/screenshot1_main_page.png | |
12 | `pudge`_, and `pygments`_. The ``pudge`` command is disabled by |
|
43 | :align: left | |
13 | default; to ativate it in your project, run:: |
|
44 | ||
|
45 | Main page of RhodeCode | |||
|
46 | ||||
|
47 | .. figure:: images/screenshot2_summary_page.png | |||
|
48 | :align: left | |||
|
49 | ||||
|
50 | Summary page | |||
|
51 | ||||
|
52 | ||||
|
53 | **Incoming** | |||
|
54 | ||||
|
55 | - code review based on hg-review (when it's stable) | |||
|
56 | - git support (when vcs can handle it - almost there !) | |||
|
57 | - commit based wikis | |||
|
58 | - clonning from remote repositories into rhodecode (git/mercurial) | |||
|
59 | - other cools stuff that i can figure out (or You can help me figure out) | |||
14 |
|
60 | |||
15 | setup.py addcommand -p buildutils.pudge_command |
|
61 | Documentation | |
|
62 | ============= | |||
|
63 | ||||
|
64 | **Installation:** | |||
|
65 | ||||
|
66 | .. toctree:: | |||
|
67 | :maxdepth: 1 | |||
|
68 | ||||
|
69 | installation | |||
|
70 | setup | |||
16 |
|
71 | |||
17 | .. _buildutils: http://pypi.python.org/pypi/buildutils |
|
72 | Other topics | |
18 | .. _pudge: http://pudge.lesscode.org/ |
|
73 | ============ | |
19 | .. _pygments: http://pygments.org/ |
|
74 | ||
|
75 | * :ref:`genindex` | |||
|
76 | * :ref:`search` | |||
|
77 | ||||
|
78 | .. _python: http://www.python.org/ | |||
|
79 | .. _django: http://www.djangoproject.com/ | |||
|
80 | .. _mercurial: http://mercurial.selenic.com/ | |||
|
81 | .. _subversion: http://subversion.tigris.org/ | |||
|
82 | .. _git: http://git-scm.com/ No newline at end of file |
General Comments 0
You need to be logged in to leave comments.
Login now