CentOS 7de Birden Çok Biçimde Belge Oluşturmak için Sfenksi Kullanma

• Ön şartlar
• 1. Adım: Sistemi güncelleyin
• Adım 2: Pip ve Sfenks'i kurun
• 3. Adım: Belgeleriniz için temel yapılandırmayı ayarlayın
• 4. Adım: Belgeleriniz için hiyerarşi oluşturun
• 5. Adım: Yukarıda belirtilen kaynak dosyaları oluşturun
• 6. Adım: Belgelerinizin HTML sürümünü çıktılayın

Sfenks, teknisyenler ve yazarlar için, çeşitli formatlarda zarif, tamamen işlevsel belgeler oluşturmalarını sağlayan kullanışlı bir Python tabanlı araçtır. Sphinx ile, yeni başlayanlar için hafif bir biçimlendirme dili olan reStructuredText'i kullanarak belge yazarsınız, çıktıyı HTML, LaTeX, PDF, ePub ve diğerleri de dahil olmak üzere birden çok biçimde alabilirsiniz.

Bu derste, SphinxVult platformuna bir CentOS 7 x64 örneği kurma ve kullanma sürecini ele alacağız .

Ön şartlar

• Bir CentOS 7 x64 örneği.
• Bir sudo kullanıcısı .

1. Adım: Sistemi güncelleyin

sudo yum update
sudo shutdown -r now

Adım 2: Pip ve Sfenks'i kurun

sudo yum install -y python-devel python-setuptools python-pip
sudo pip install --upgrade pip
sudo pip install -U Sphinx

3. Adım: Belgeleriniz için temel yapılandırmayı ayarlayın

Kullanmaya başlamadan önce Sphinx, Sphinxtüm belgelerinizi çalıştıracak ve kaydedecek kaynak dizini belirtmeniz gerekir . Kullanmak istediğiniz dizini oluşturduktan sonra , gerekli temel yapılandırmayı sphinx-quickstartbaşlatacak Sphinxve oluşturacak şekilde çalıştırabilirsiniz .

sphinx-quickstart , projenizin özelliklerini belirleyen sorular soracak bir kurulum sihirbazına benzer.

cd ~
mkdir doc1
cd doc1
sphinx-quickstart

4. Adım: Belgeleriniz için hiyerarşi oluşturun

Varsayılan olarak, sphinx-quickstartsihirbaz birkaç dizin ve dosya oluşturur.

_build           # The directory for containing Sphinx output
conf.py          # The file containing your project configurations
index.rst        # The master file containing the hierarchy of your documentation
make.bat         # A Windows command file
Makefile         # A file necessary for running the make command
_static          # The directory for static files, including custom stylesheets, pictures, etc.
_templates       # The directory for custom templates

index.rstBelgelerinizin hiyerarşisini içeren ana dosyaya bakalım ; yani, içindekiler ağacı veya toctree.

Bir metin düzenleyicisiyle açın:

vi index.rst

Dosyayı incelerken, adlı bir bölüm göreceksiniz toctree. *.rstBelgeleriniz için başka kaynak dosyalarınız ( ) varsa, bunları şu toctreebölümde belirtmeniz gerekir : .. toctree ::: maxdepth: 2

   introduction
   chapter1
   chapter2
   chapter3
   more

Aşağıdakiler zorunludur:

• Girişinizin üstünde boş bir satır bırakın.
• Kaynak dosyalarınızın son ekini kullanmayın .rst.
• Kaynak dosyalarınızı ilgili sırayla yerleştirin.
• Her satırda yalnızca bir dosya adı kullanın.
• İle dosya adlarınızı girin :maxdepth: 2.

Değişikliklerinizi tamamladıktan sonra dosyanızı kaydedin ve metin düzenleyicisinden çıkın.

ESC
:!wq

5. Adım: Yukarıda belirtilen kaynak dosyaları oluşturun

Kaynak dosyalar, daha önce belirtilenlerle eşleşen adlarla oluşturulmalıdır index.rst, aksi takdirde son çıktıya dahil edilmezler.

Tüm kaynak dosyalar ile uyumlu olmalıdır reStructuredText markup language. Daha fazla bilgi için lütfen reStructuredText Primer'a başvurun .

6. Adım: Belgelerinizin HTML sürümünü çıktılayın

Belgelerinizi oluşturmayı tamamladıktan sonra HTML format , aşağıdaki komutu yürüterek çalışmalarınızın çıktısını alabilirsiniz :

make html

Çıktı ./\_build/html, dosyayı web'e göz atmak için gereken her şeyi içeren dizine kaydedilir .

Bu öğreticimizi sonlandırıyor.