aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSlava Bacherikov <slava@bacher09.org>2012-08-20 02:18:29 +0300
committerSlava Bacherikov <slava@bacher09.org>2012-08-20 02:18:29 +0300
commit0da3ae5f47cdd21ce84f836d84ffce219050c2f2 (patch)
tree781f954a1bc9ada2230b639b4b6ded7c219e2c34
parentUpdate flags descr in scanpackages command (diff)
downloadgentoo-packages-0da3ae5f47cdd21ce84f836d84ffce219050c2f2.tar.gz
gentoo-packages-0da3ae5f47cdd21ce84f836d84ffce219050c2f2.tar.bz2
gentoo-packages-0da3ae5f47cdd21ce84f836d84ffce219050c2f2.zip
Add docs
-rw-r--r--.gitignore1
-rw-r--r--docs/Makefile153
-rw-r--r--docs/build/.empty0
-rw-r--r--docs/make.bat190
-rw-r--r--docs/source/commands.rst185
-rw-r--r--docs/source/conf.py291
-rw-r--r--docs/source/index.rst41
-rw-r--r--docs/source/install.rst41
-rw-r--r--docs/source/package_info.rst119
9 files changed, 1021 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index 486eec4..6cc8327 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
*.sw[op]
*.db
gpackages/main/local_settings.py
+docs/build/*
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..b162467
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,153 @@
+# 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) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @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/GentooPackages.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/GentooPackages.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/GentooPackages"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/GentooPackages"
+ @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."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
diff --git a/docs/build/.empty b/docs/build/.empty
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/build/.empty
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..2b72a55
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,190 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+set I18NSPHINXOPTS=%SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+ set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+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. texinfo to make Texinfo files
+ echo. gettext to make PO message catalogs
+ 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
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ 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
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\GentooPackages.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\GentooPackages.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "texinfo" (
+ %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+ goto end
+)
+
+if "%1" == "gettext" (
+ %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ 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
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
diff --git a/docs/source/commands.rst b/docs/source/commands.rst
new file mode 100644
index 0000000..01d41ce
--- /dev/null
+++ b/docs/source/commands.rst
@@ -0,0 +1,185 @@
+.. _commands:
+
+Commands
+============
+
+In addition to django commands this programs such commands:
+
+ * `addmising`_
+ * `generatestyle`_
+ * `listrepos`_
+ * `scanherds`_
+ * `scanlicensetext`_
+ * `scannews`_
+ * `scanpackages`_
+ * `scanrepoinfo`_
+ * `scanusedesc`_
+ * `setlatestebuilds`_
+ * `simplestats`_
+ * `updateebuildmask`_
+ * `update_stats`_
+
+.. _addmising:
+
+addmising command
+--------------------
+
+Detecting updated package is done by manifest hash. If manifest hash is changed,
+package is updated. But sometimes may happen such situation -- when manifest
+changed and include hash of new ebuilds but new ebuilds files are not commited.
+Then new hash of package would be in database, but when these ebuilds will be
+added to that package, they would be not detected as updated, because manifest
+was not changed.
+
+You could update all packages by scanning with ``--force-update`` flag, but
+this would change package update time and many other info. So for fixing such
+issues use **addmising** command.
+
+
+.. _generatestyle:
+
+generatestyle command
+---------------------
+
+This command will generate and print CSS style for package changelog.
+In most cases you don't need it.
+
+
+.. _listrepos:
+
+listrepos command
+------------------
+
+Will output list of available repositories and full path to them.
+
+Example::
+
+ [gentoo] /usr/portage
+ [gentoo-haskell] /var/lib/layman/haskell
+ [sunrise] /var/lib/layman/sunrise
+ [sabayon] /var/lib/layman/sabayon
+ [pentoo] /var/lib/layman/pentoo
+
+.. _scanherds:
+
+scanherds command
+------------------
+
+Will scan only herds.xml data.
+
+.. note::
+
+ By default scanpackages allways scan herds data, so use this command if you
+ want update only herds data without packages.
+ For updating herds with package use :ref:`scanpackages <scanpackages>` command.
+
+
+.. _scanlicensetext:
+
+scanlicensetext command
+-----------------------
+
+Will set license text for each license in database. Execute it when you have
+licenses in database.
+
+
+.. _scannews:
+
+scannews command
+----------------
+
+Will scan package news.
+
+.. _scanpackages:
+
+scanpackages command
+--------------------
+
+This is main scanning command. It scan packages data.
+It accept repository names as arguments.
+
+Have following flags:
+ * ``-a``, ``--all`` -- Scan all repositories
+ * ``--force-update`` -- Force updating
+ * ``--not-scan-herds`` -- not scan herds.xml
+ * ``-r``, ``--update-repo`` -- Update repository info
+ * ``--not-show-time`` -- Show time of scanning
+ * ``--not-del`` -- Don't delete
+ * ``--clear-cache`` -- Clear cache
+ * ``--not-license-groups`` -- Not scan license groups
+ * ``-h``, ``--help`` -- show this help message and exit
+ * ``-v VERBOSITY``, ``--verbosity=VERBOSITY`` -- set verbosity level
+
+Examples:
+
+ * ``./manage.py scanpackages gentoo`` -- scan packages in main repository
+ * ``./manage.py scanpackages gentoo sunrise`` -- scan packages in main repository and sunrise overlay
+ * ``./manage.py scanpackages -a`` -- scan packages in all repositories
+ * ``./manage.py scanpackages -a -v 0`` -- scan packages in all repositories, quiet mode
+
+
+.. _scanrepoinfo:
+
+scanrepoinfo command
+--------------------
+
+Will scan only repository metadata(not packages). Without args scan metadata in
+all repositories, with args use them as repositories names.
+
+Have following flags:
+
+ * ``--not-show-time`` -- Show time of scanning
+ * ``--del`` -- Delete unavailable repositories
+
+
+.. note::
+
+ By default scanpackages allways scan repository data, so use this command if you
+ want update only repositories metadata without packages.
+ For updating repositories metadata with packages use :ref:`scanpackages <scanpackages>` command.
+
+.. _scanusedesc:
+
+scanusedesc command
+-------------------
+
+Will scan use flag descriptions
+
+.. _setlatestebuilds:
+
+setlatestebuilds command
+------------------------
+
+Will set link to last ebuild in package model for showing some ebuild data in
+package view. Should done periodically.
+
+.. _simplestats:
+
+simplestats command
+-------------------
+
+Will output simple repositories stats
+
+Example::
+
+ "Repo name" "Packages" "Ebuilds" "Maintainers" "Herds"
+ gentoo 15733 31805 473 143
+ gentoo-haskell 872 1203 3 4
+ sunrise 681 719 2 0
+ sabayon 430 830 61 36
+ pentoo 325 475 17 7
+
+
+.. _updateebuildmask:
+
+updateebuildmask command
+------------------------
+
+Will update mask of each ebuild.
+
+.. _update_stats:
+
+update_stats command
+--------------------
+
+Will update precomputed stats info in database.
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..5e03907
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,291 @@
+# -*- coding: utf-8 -*-
+#
+# Gentoo Packages documentation build configuration file, created by
+# sphinx-quickstart on Wed Aug 8 20:47:22 2012.
+#
+# 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
+DIR = os.path.dirname(__file__)
+PROJECT_PATH = os.path.abspath(os.path.join(DIR, '../..'))
+PROJECT_ROOT = os.path.join(PROJECT_PATH, 'gpackages')
+sys.path.insert(0, os.path.join(PROJECT_ROOT, 'libs'))
+sys.path.insert(0, os.path.join(PROJECT_ROOT, 'apps'))
+
+# 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.todo', 'sphinx.ext.coverage', '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'Gentoo Packages'
+copyright = u'2012, Slava Bacherikov'
+
+# 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 = '0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.0.1'
+
+# 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 = []
+
+# 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 = 'default'
+
+# 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 = []
+
+# 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 = 'GentooPackagesdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'GentooPackages.tex', u'Gentoo Packages Documentation',
+ u'Slava Bacherikov', '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
+
+# 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', 'gentoopackages', u'Gentoo Packages Documentation',
+ [u'Slava Bacherikov'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'GentooPackages', u'Gentoo Packages Documentation',
+ u'Slava Bacherikov', 'GentooPackages', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'Gentoo Packages'
+epub_author = u'Slava Bacherikov'
+epub_publisher = u'Slava Bacherikov'
+epub_copyright = u'2012, Slava Bacherikov'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# A tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
+autoclass_content = 'both'
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..0211fa1
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,41 @@
+.. -*- mode: rst; encoding: utf-8 -*-
+.. Gentoo Packages documentation master file, created by
+ sphinx-quickstart on Wed Aug 8 20:47:22 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Introduction
+============
+
+``gentoo-packages`` is new version of `packages.gentoo.org`_ site writen on Python using `Django`_ framework.
+
+
+You could find sources on `GitHub <https://github.com/bacher09/gentoo-packages>`_ or `here <http://git.overlays.gentoo.org/gitweb/?p=proj/gentoo-packages.git;a=summary>`_.
+
+
+.. _packages.gentoo.org: http://packages.gentoo.org/
+.. _Django: https://www.djangoproject.com/
+
+
+Documentation
+=============
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+ :numbered:
+
+ install
+ commands
+ package_info
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/source/install.rst b/docs/source/install.rst
new file mode 100644
index 0000000..ad2ba04
--- /dev/null
+++ b/docs/source/install.rst
@@ -0,0 +1,41 @@
+Installation
+============
+
+First you should insall all required depences see it in Requirements.
+
+.. literalinclude:: ../../Requirements
+
+Next you should configure database and create ``local_settings.py`` in ``gpackages/main/`` dir, you could see ``local_settings.py.example`` as example.
+
+.. literalinclude:: ../../gpackages/main/local_settings.py.example
+ :language: python
+
+After creating configuration you need create tables in your database, for this execute these commands::
+
+ $ cd gpackages
+ $ ./manage.py syncdb
+ $ ./manage.py migrate
+
+Then maybe you want collect first packages data, for this you need execute that command::
+
+ $ ./manage.py scanpackages -a
+
+This will collect info about all packages in all overlays.
+If you want check what overlays available, then type this command::
+
+ $ ./manage.py listrepos
+
+After first scanning you should also add info about use flags and licenses text
+You could do this with such commands::
+
+ $ ./manage.py scanusedesc
+ $ ./manage.py scanlicensetext
+
+Now you could run demo web-server::
+
+ $ ./manage.py runserver
+
+For deployment check `django deployment docs`_.
+For more commands see :ref:`commands`.
+
+.. _`django deployment docs`: https://docs.djangoproject.com/en/1.4/howto/deployment/wsgi/modwsgi/
diff --git a/docs/source/package_info.rst b/docs/source/package_info.rst
new file mode 100644
index 0000000..c526386
--- /dev/null
+++ b/docs/source/package_info.rst
@@ -0,0 +1,119 @@
+package_info module
+===================
+
+.. automodule:: package_info
+ :members:
+
+package_info.abstract submodule
+------------------------------
+
+.. automodule:: package_info.abstract
+ :members:
+
+package_info.generic submodule
+------------------------------
+
+.. automodule:: package_info.generic
+ :members:
+
+package_info.generic_objects submodule
+------------------------------
+
+.. automodule:: package_info.generic_objects
+ :members:
+
+package_info.generic_metadata submodule
+------------------------------
+
+.. automodule:: package_info.generic_metadata
+ :members:
+
+package_info.generic_metadata.category_metadata submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.category_metadata
+ :members:
+
+package_info.generic_metadata.changelog_highlight submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.changelog_highlight
+ :members:
+
+package_info.generic_metadata.herds submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.herds
+ :members:
+
+package_info.generic_metadata.license_groups submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.license_groups
+ :members:
+
+package_info.generic_metadata.license_text submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.license_text
+ :members:
+
+package_info.generic_metadata.my_etree submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.my_etree
+ :members:
+
+package_info.generic_metadata.news submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.news
+ :members:
+
+package_info.generic_metadata.package_metadata submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.package_metadata
+ :members:
+
+package_info.generic_metadata.repo_const submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.repo_const
+ :members:
+
+package_info.generic_metadata.repo_info submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.repo_info
+ :members:
+
+package_info.generic_metadata.use_info submodule
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: package_info.generic_metadata.use_info
+ :members:
+
+package_info.mixins submodule
+------------------------------
+
+.. automodule:: package_info.mixins
+ :members:
+
+package_info.parse_cp submodule
+------------------------------
+
+.. automodule:: package_info.parse_cp
+ :members:
+
+package_info.utils submodule
+------------------------------
+
+.. automodule:: package_info.utils
+ :members:
+
+package_info.validators submodule
+------------------------------
+
+.. automodule:: package_info.validators
+ :members: