Kaydet (Commit) c8958afe authored tarafından Suleyman Poyraz's avatar Suleyman Poyraz

düzgün bir dokümentasyon için

üst dc21f557
# -*- coding: utf-8 -*-
#
# documentation build configuration file, created by
# sphinx-quickstart on Wen Feb 7 18:41:23 2018
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed
# automatically).
#
# All configuration values have a default value; values that are commented out
# serve to show the default value.
import sys
import os
# pip install sphinx_rtd_theme
# import sphinx_rtd_theme
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
VERSION = '1.0'
AUTHOR = 'Zaryob'
# General configuration
# ---------------------
# 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.intersphinx']
# Later on, add 'sphinx.ext.viewcode' to the list if you want to have
# colorized code generated too for references.
# Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General substitutions.
project = 'Inary Documentation'
copyright = "2016-2017 Zaryob"
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
version = VERSION
# The full version, including alpha/beta/rc tags.
release = VERSION
# 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 documents that shouldn't be included in the build.
# unused_docs = []
# List of directories, relative to source directories, that shouldn't be
# searched for source files.
# exclude_dirs = []
# A list of glob-style patterns that should be excluded when looking
# for source files.
exclude_patterns = ['modules']
# 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'
highlight_language = 'YAML+Jinja'
# Substitutions, variables, entities, & shortcuts for text which do not need to link to anything.
# For titles which should be a link, use the intersphinx anchors set at the index, chapter, and section levels, such as qi_start_:
rst_epilog = """
"""
# Options for HTML output
# -----------------------
html_theme_path = ['../_themes']
html_theme = 'highlight'
html_short_title = 'Inary Documentation'
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
# html_style = 'solar.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Inary Documentation'
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
# The name of an image file (within the static path) 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 = 'favicon.ico'
# 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_use_modindex = 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, the reST sources are included in the HTML build as _sources/<name>.
html_copy_source = False
# 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 = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'Poseidodoc'
# 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, document class
# [howto/manual]).
latex_documents = [
('index', 'ansible.tex', 'Ansible 2.2 Documentation', AUTHOR, '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
# 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_use_modindex = True
autoclass_content = 'both'
intersphinx_mapping = {'python3': ('https://docs.python.org/3/', (None, '../python3-3.6.2.inv')),
'jinja2': ('http://jinja.pocoo.org/docs/', (None, '../jinja2-2.9.7.inv'))}
Inary Commands
==============
The All Commands
````````````````
.. toctree::
:maxdepth: 2
build.rst
check.rst
clean.rst
configure-pending.rst
delete-cache.rst
delta.rst
dist-update.rst
emerge.rst
emergeup.rst
graph.rst
index_command.rst
info.rst
list_commands.rst
orphaned_command.rst
remove.rst
repo_commands.rst
search.rst
upgrade.rst
Coding for Inary
==============================
.. toctree::
:maxdepth: 2
developer_roles
coding_for_inary
making_inary_packages
Inary
=====
.. toctree::
:maxdepth: 2
about_components
about_scom_scripts
Inary Handbook
==============
About Documentation
```````````````````
Welcome to Inary documentation
This documentation about Inary package managing system.
.. _an_introduction:
.. toctree::
:maxdepth: 2
about_inary
installing_inary
inary_commands/index
inary_types/index
inary_tools/index
developing_inary/index
most_questions
This documentation licensed with GPL-3.
Inary Doc
===============
.. _an_introduction:
.. toctree::
:maxdepth: 2
tr/index
en/index
This documentation Licensed with GPL-3.
Inary Komutları
===============
Inary paket yönetim sistemi standart kullanıcının beklediği tüm komutları
içerdiği gibi kendine özel komutlar da içerir.
inary help diyerek bütün komutları görebilirsiniz.
.. shell::
$ inary help
usage: inary [seçenekler] <komut> [parametreler]
<komut> aşağıdakilerden birisi olabilir:
add-repo (ar) - Depo ekle
blame (bl) - Paket sahibi ve yayım bilgisi
build (bi) - Verilen INARY paket(ler)ini inşa et
check - Kurulumu denetle
clean - Kullanılmayan kilitleri temizle
configure-pending (cp) - Configure pending packages
delete-cache (dc) - Önbellek dosyalarını temizle
delta (dt) - Delta paketleri yarat
disable-repo (dr) - Depoyu pasifleştir
dist-update (distup) - Update the system a new release
emerge (em) - INARY kaynak paketlerini depodan inşa et ve kur
emergeup (emup) - INARY kaynak paketlerini depodan inşa et ve yükselt
enable-repo (er) - Depoyu etkinleştir
fetch (fc) - Paket indir
graph - Paket ilişkilerinin grafiğini çıkar
help (?) - Verilen komutlar hakkında yardım görüntüler
history (hs) - INARY işlemlerinin günlüğü
index (ix) - Index INARY files in a given directory
info - Paket bilgisini göster
install (it) - INARY paket(ler)i kur
list-available (la) - Depolardaki paketleri listele
list-components (lc) - Bileşenleri listele
list-installed (li) - Tüm kurulu paketlerin listesini bas.
list-newest (ln) - Depolardaki en yeni paketleri listele
list-orphaned (lo) - List orphaned packages
list-pending (lp) - Bekleyen paketleri listele
list-repo (lr) - Depoları listele
list-sources (ls) - Müsait kaynakları listele
list-upgrades (lu) - Yükseltilecek paketleri listele
rebuild-db (rdb) - Veritabanlarını Yeniden İnşa Et
remove (rm) - INARY paketlerini kaldır
remove-orphaned (ro) - Remove orphaned packages
remove-repo (rr) - Depoları kaldır
search (sr) - Paket ara
search-file (sf) - Dosya ara
update-repo (ur) - Depo veritabanlarını güncelle
upgrade (up) - INARY paketlerini güncelle
Belirli bir komut hakkında yardım almak için "inary help <komut>" kullanınız.
Seçenekler:
--version : programın sürüm numarasını göster ve çık
-h [--help] : bu yardım iletisini göster ve çık
genel seçenekler:
-D [--destdir] arg : INARY komutları için sistem kökünü değiştir.
-y [--yes-all] : Bütün evet/hayır sorularında cevabı evet kabul
et.
-u [--username] arg
-p [--password] arg
-L [--bandwidth-limit] arg : Bant genişliği kullanımını belirtilen kilobaytın
altında tut.
-v [--verbose] : Detaylı çıktı
-d [--debug] : Hata ayıklama bilgisini göster.
-N [--no-color] : INARY çıktılarında renk kullanılmasını engeller.
Tüm Komutlar Hakkında
`````````````````````
.. toctree::
:maxdepth: 2
build.rst
check.rst
clean.rst
configure-pending.rst
delete-cache.rst
delta.rst
dist-update.rst
emerge.rst
emergeup.rst
graph.rst
index_command.rst
info.rst
list_commands.rst
orphaned_command.rst
remove.rst
repo_commands.rst
search.rst
upgrade.rst
Geliştirme Yapmak ve Katkıda Bulunmak
=====================================
Inary paket yönetim sistemi Sulin Topluluğuna bağlı olmak ile beraber
isteyen kişiler Inary'i geliştirmeye yardımcı olabilirler. Yardımcı olmak
isteyenler, paketlerini yapmak yayınlamak bizimle paylaşmak isteyenler ve
diğer tüm şeyler hakkında:
.. toctree::
:maxdepth: 2
developer_roles
coding_for_inary
making_inary_packages
Inary'e Ait Tanımlar
====================
.. toctree::
:maxdepth: 2
about_components
about_scom_scripts
Inary El Kitabı
===============
Dokumantasyon Hakkında
``````````````
Inary documentasyonuna hoş geldiniz.
Bu dokumantasyon Inary paket yönetimi hakkında tüm bilgileri vermektedir.
.. _an_introduction:
.. toctree::
:maxdepth: 2
about_inary
installing_inary
inary_commands/index
inary_types/index
inary_tools/index
developing_inary/index
most_questions
Bu dokumantasyon AGPL-3 ile lisanslanmıştır.
Inary Packet Yöneticisinin Kurulumu
===================================
Inary paket yöneticisi üç farklı şekilde kurulabilir:
* Tam Kurulum: Sistemde tek başına bütün paket işlerini inary yapar ve sistemde
bulunan tüm paketleri analiz edip mevcut kuruluma dokunmadan tüm kurulu
uygulamalarınızı otomatik olarak inary veritabanına işler. Tercihe bağlı olarak
diğer paket yönetim yazılımlarını siler.
* Sınırlandırılmış Kurulum: Kurulum yapılan kullanıcının kendi home dizini altında
inary paketlerini kurup kaldırmasına olanak tanıyan bir kurulum çeşitidir.
Sınırlandırılmış kurulumda sistemde mevcut başka bir paket yönerim yazılımı var
ise dokunmaz, hiçbir dosya işlemi kök dizin altında yapılmaz ve inary ile yapılan
tüm işler '~/.inary' dizini silinerek yok edilebilir.
* Portable Kurulumu: Herhangi başka bir yazılıma ihtiyaç duymadan inary ve python3'ün
MacOS, Solaris ve benzeri sistemlerde tek tıkla kurulumuna olanak verir. Geriye
kalan tüm özellikleri sınırlandırılmış kurulum ile aynıdır
.. note:: Inary paket yöneticisi herbir kurulum şekli için ayrı bir paket
deposu içerir. Kurulum şeklinize uygun depo kullanmanız önemle rica edilir.
Tam Kurulum
```````````
Eğer geliştirilen son sürümü kullanmak istiyorsanız
.. code-block:: shell
git clone https://git.sulin.org/inary.git
sudo python3 setup.py install
inary-rebuild-system
inary rdb
Eğer mevcut bulunan en kararlı sürümü kullanmak istiyorsanız
.. code-block:: shell
wget https://sulin.org/inary/download/lastest.tar.gz
tar xvf lastest.tar.gz
cd inary/
sudo python3 setup.py install
inary-rebuild-system
inary rdb
.. note:: setup.py scripti ile kurulum yaparken otomatik olarak
tüm bağımlılıklar internet üzerinden indirilir.
Sınırlandırılmış kurulum
````````````````````````
Eğer geliştirilen son sürümü kullanmak istiyorsanız
.. code-block:: shell
mkdir ~/.inary
git clone https://git.sulin.org/inary.git
python3 setup.py build
python3 setup.py install --root=~/.inary
inary rdb
Eğer mevcut bulunan en kararlı sürümü kullanmak istiyorsanız
.. code-block:: shell
mkdir ~/.inary
wget https://sulin.org/inary/download/lastest.tar.gz
tar xvf lastest.tar.gz
cd inary/
python3 setup.py build
python3 setup.py install --root=~/.inary
inary rdb
Portable kurulum
````````````````
.. code-block:: shell
wget https://sulin.org/inary/download/portable.tar.gz
tar xvf portable.tar.gz
mv portable ~/.inary
inary rdb
Inary'i Güncelleştirmek
```````````````````````
Inary kullandığınız inary'i kullanarak güncelleştirmeye olanak verir.
.. code-block:: shell
inary ur
inary up inary
Scom Kullanmadan Paket İşlemi Yapmak
````````````````````````````````````
Inary paket yönetim sistemi eski pisi bağımlılığı olan ve pisi packet konfigurasyon
betiklerini içerisinde bulunduran comar sistemini forklayıp geliştirmiştir.
Ancak mevcut inary eskiden farklı olarak scom kullanmadan paket işlemi yapmaya
olanak verir. Ancak bu durumda paketlerin kurulumundan sonraki konfigurasyon
tamamen kullanıcıya bırakılmıştır.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment