Użyj Sphinx do utworzenia dokumentacji w wielu formatach w CentOS 7

Sphinx to przydatne narzędzie oparte na języku Python dla techników i pisarzy, które pozwala im z łatwością tworzyć elegancką, w pełni funkcjonalną dokumentację w różnych formatach. Dzięki Sphinx piszesz dokumenty za pomocą reStructuredText - lekkiego języka znaczników - na początek, a następnie możesz uzyskać wynik w wielu formatach, w tym HTML, LaTeX, PDF, ePub i innych.

W tym samouczku omówimy proces instalacji i używania Sphinxw instancji CentOS 7 x64 na platformie Vult.

Wymagania wstępne

  • Instancja CentOS 7 x64.
  • Użytkownik sudo .

Krok 1: Zaktualizuj system

sudo yum update
sudo shutdown -r now

Krok 2: Zainstaluj pip i Sphinx

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

Krok 3: Skonfiguruj podstawową konfigurację dokumentacji

Przed rozpoczęciem użytkowania Sphinxmusisz określić katalog źródłowy, w którym Sphinxzostanie uruchomiony i zapisać całą dokumentację. Po utworzeniu katalogu, którego chcesz używać, możesz uruchomić, sphinx-quickstartktóry zainicjuje Sphinxi utworzy wymaganą konfigurację podstawową.

sphinx-quickstart jest podobny do kreatora konfiguracji, który zadaje pytania, które określają aspekty twojego projektu.

cd ~
mkdir doc1
cd doc1
sphinx-quickstart

Krok 4: Zbuduj hierarchię dla swojej dokumentacji

Domyślnie sphinx-quickstartkreator utworzy kilka katalogów i plików.

_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

Rzućmy okiem na plik główny index.rst, który zawiera hierarchię twojej dokumentacji; mianowicie drzewo spisu treści lub toctree.

Otwórz go za pomocą edytora tekstu:

vi index.rst

Podczas przeglądania pliku zauważysz sekcję o nazwie toctree. Jeśli masz inne pliki źródłowe ( *.rst) do swojej dokumentacji, musisz je określić w toctreesekcji: .. toctree ::: maxdepth: 2

   introduction
   chapter1
   chapter2
   chapter3
   more

Konieczne jest:

  • Pozostaw pusty wiersz nad wprowadzonymi danymi.
  • Nie sufikuj plików źródłowych za pomocą .rst.
  • Umieść pliki źródłowe w odpowiedniej kolejności.
  • Użyj tylko jednej nazwy pliku na wiersz.
  • Wcięcie nazw plików za pomocą :maxdepth: 2.

Po zakończeniu modyfikacji zapisz plik i zamknij edytor tekstu.

ESC
:!wq

Krok 5: Utwórz pliki źródłowe określone powyżej

Pliki źródłowe muszą zostać utworzone z nazwami zgodnymi z wcześniej określonymi, w index.rstprzeciwnym razie nie zostaną uwzględnione w końcowym wyniku.

Wszystkie pliki źródłowe muszą być zgodne z reStructuredText markup language. Aby uzyskać więcej informacji, odwołaj się do reStructuredText Primer .

Krok 6: Wydrukuj wersję HTML swojej dokumentacji

Po zakończeniu tworzenia dokumentacji możesz wydrukować swoją pracę HTML format , wykonując poniższe polecenie:

make html

Dane wyjściowe zostaną zapisane w katalogu, ./\_build/htmlktóry zawiera wszystko, co niezbędne do przeglądania pliku podczas przeglądania stron internetowych.

To kończy nasz samouczek.



Leave a Comment

Funkcjonalności warstw architektury referencyjnej Big Data

Funkcjonalności warstw architektury referencyjnej Big Data

Przeczytaj blog, aby w najprostszy sposób poznać różne warstwy w architekturze Big Data i ich funkcjonalności.

Rewolucyjne wynalazki Google, które ułatwią Twoje życie.

Rewolucyjne wynalazki Google, które ułatwią Twoje życie.

Chcesz zobaczyć rewolucyjne wynalazki Google i jak te wynalazki zmieniły życie każdego człowieka dzisiaj? Następnie czytaj na blogu, aby zobaczyć wynalazki Google.

13 komercyjnych narzędzi do ekstrakcji danych z Big Data

13 komercyjnych narzędzi do ekstrakcji danych z Big Data

13 komercyjnych narzędzi do ekstrakcji danych z Big Data

Pozostań w kontakcie dzięki aplikacji WhatsApp na komputer 24*7

Pozostań w kontakcie dzięki aplikacji WhatsApp na komputer 24*7

Whatsapp w końcu uruchomił aplikację Desktop dla użytkowników komputerów Mac i Windows. Teraz możesz łatwo uzyskać dostęp do Whatsapp z systemu Windows lub Mac. Dostępne dla Windows 8+ i Mac OS 10.9+

5 przykładów, które dowodzą, że energetyka jądrowa nie zawsze jest zła

5 przykładów, które dowodzą, że energetyka jądrowa nie zawsze jest zła

Energia jądrowa jest zawsze pogardzana, nigdy jej nie szanujemy z powodu przeszłych wydarzeń, ale nie zawsze jest zła. Przeczytaj post, aby dowiedzieć się więcej na ten temat.

Friday Essential: Co się stało z samochodami sterowanymi przez sztuczną inteligencję?

Friday Essential: Co się stało z samochodami sterowanymi przez sztuczną inteligencję?

Koncepcja autonomicznych samochodów, które wyjadą na drogi za pomocą sztucznej inteligencji, to marzenie, które mamy już od jakiegoś czasu. Ale pomimo kilku obietnic nigdzie ich nie widać. Przeczytaj ten blog, aby dowiedzieć się więcej…

Czy AI może walczyć z rosnącą liczbą ataków ransomware?

Czy AI może walczyć z rosnącą liczbą ataków ransomware?

Wzrasta liczba ataków ransomware, ale czy sztuczna inteligencja może pomóc w radzeniu sobie z najnowszym wirusem komputerowym? Czy AI jest odpowiedzią? Przeczytaj tutaj, wiedz, że sztuczna inteligencja jest zmorą lub zgubą

5 przydatnych narzędzi sztucznej inteligencji, które uproszczą Twoje życie

5 przydatnych narzędzi sztucznej inteligencji, które uproszczą Twoje życie

Sztuczna inteligencja nie jest dla ludzi nową nazwą. Ponieważ sztuczna inteligencja jest włączona do każdego strumienia, jednym z nich jest opracowywanie narzędzi zwiększających ludzką wydajność i dokładność. Skorzystaj z tych niesamowitych narzędzi uczenia maszynowego i uprość swoje codzienne zadania.

Wgląd w 26 technik analizy Big Data: część 2

Wgląd w 26 technik analizy Big Data: część 2

Zawsze potrzebujemy Big Data Analytics do efektywnego zarządzania danymi. W tym artykule omówiliśmy kilka technik analizy Big Data. Sprawdź ten artykuł.

Ataki DDOS: krótki przegląd

Ataki DDOS: krótki przegląd

Czy jesteś również ofiarą ataków DDOS i nie masz pewności co do metod zapobiegania? Przeczytaj ten artykuł, aby rozwiązać swoje pytania.