BLOG

Linux Sphinx Tool

01/02/2017 tarihinde Fatih AKTOLAN tarafından yazılmıştır.

Basit ve kullanışlı bir dökümantasyon aracıdır.
http://sphinxsearch.com/




Sphinx Gereksinimler


1-Python 2.7 / Python 3.0
2-Vim Editor

Kurulum


Vim Editor Kurulum:
sudo apt-get install vim
Sphinx Teminal Üzerinden Kurulum:
easy_install -U Sphinx

Sphinx Proje Oluşturma


Terminal üzerinden yapılması gerekenler:
tbtk@tbtk-virtual-machine ~ $ cd /media/tbtk/FATİH/tbtk/fatih_aktolan_wiki/
tbtk@tbtk-virtual-machine /media/tbtk/FATİH/tbtk/fatih_aktolan_wiki $ sphinx quickstart
sphinx: command not found
tbtk@tbtk-virtual-machine /media/tbtk/FATİH/tbtk/fatih_aktolan_wiki $ sphinx-quickstart
Welcome to the Sphinx 1.2.2 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]:

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]: n

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: fatih_aktolan_wiki
> Author name(s): Fatih Aktolan

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 1.0
> Project release [1.0]: 1.0.0

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y //burda kesinlikle oto dökümantasyona evet denmeli
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]: y //burda da meke file yes olarak işaretlenmeli
> Create Windows command file? (y/n) [y]: n //windows üzerinde iseniz buna yes dememlisiniz

Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.

Finished: An initial directory structure has been created.

You should now populate your master file ./index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

Sphinx Dökümantasyonunun Yayınlanması


1-Projeyi oluşturduğumuz dizine geçip index.rst dosyası vim ile açılırsa aşağıdaki gibi görünür genel hatları ile iskeleti açıklayalım:
.. fatih_aktolan_wiki documentation master file, created by
sphinx-quickstart on Mon Apr 14 08:53:16 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

fatih_aktolan_wiki!
==============================================  //burası da site başlığı

Contents:

// burası sayfa içeriğini yazdığımız yer oluyor sayfa ile ilgili bölümleri buraya yazarız.

.. toctree::
        :maxdepth: 2

        spinx_tool
        django_tool //bunlar dosya isimleri aynı dizinde olmalı.Ayrıca dosyalrı aynı hizada tanımlamalıyız değilse çalışmaz


        //burası index sayfasına bağlı diğer sayfaların tanımlandığı bölümDiğer sayfalar da .rst uzantılı olarak tanımlanmalı


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2-Sonraki adımda:
make html
komutu çalıştırılır. Bu komut _built/html dizini altında site dosyalarını oluşturmaktadır.Burda hatırda tutulması gereke önemli bir nokta yeni sayfa eklendiğimiz zaman bu komutla yada:
make clean//bütün dosyaları silip yeniden derliyoruz
make html
komutu ile yeniden derlenmesi gerekmektedir.
Django Tool ==============================================//başlık için altına eşittir işaretlerinden koyarız Kurulum ------------//altbaşliklar için ise çizgi çekilir //buraya içerik gelir
4-Projemizin içinde bulunan python dosyalarının özelliklerini ekrana yazdırmak için sayfamızı şu şekilde tanimlamalıyız.
Deneme.py Kod...
=====================

.. automodule:: deneme //buraya göstereceğimiz piton dosyaysının adını yazıyoruz
        :members:

Sonrasında bu özelliği çalığtırabilmek adına conf.py dosyasında aşağıdaki öz aktif hale getirmeliyiz:
sys.path.insert(0, os.path.abspath('.'))
5-Ekrana kodları formatli bir biçimde yazdırmak istiyorsak aşagıdaki yapmalıyız:
ornek kod:://burda iki tane cift nokta koymaya dikkat edin
        print "merhaba"
Burda iki noktadan sonra bir tab boşluk içerde başlamaya dikkat edilmeli

Dokümantasyonun readthedocs sitesine taşınması


1-Proje github’a taşınır
2-readthedocs sitesine giriş yapılır ve url eklenir
3-yayınlanmaya hazır

Fatih AKTOLAN

Bilgisayar Mühendisi

Yorumlar

Henüz yorum yapılmadı. Yorum yapan ilk kişi siz olun

Yorum Yaz