Sphinx: Różnice pomiędzy wersjami

(Utworzono nową stronę "''Sphinx'' to narzędzie w Pythonie służące do generowanie dokumentacji wydane na licencji BSD. === Instalacja === Przed instalacją zaleca się stworzenie izol...")
 
Linia 1: Linia 1:
''Sphinx'' to narzędzie w [[Python]]ie służące do generowanie dokumentacji wydane na licencji BSD.
+
''Sphinx'' to otwarty, w pełni tekstowy serwer wyszukiwania stworzony w C++ i udostępniony na licencji GPLv2. Najczęściej jest wykorzystywany do indeksowania danych z baz [[MySQL]], [[PostreSQL]] i specjalnie sformatowanych plików xml.
  
=== Instalacja ===
+
=== Elementy Sphinxa ===
  
Przed instalacją zaleca się stworzenie izolowanego środowiska w [[virtualenv]]. Aby zainstalować ''Sphinx'' należy skorzystać z polecenia:
+
Sphinx składa się z następujących elementów:
pip install Sphinx
 
  
A następnie w celu wygenerowania konfiguracji (należy odpowiedzieć yes na autodoc):
+
* <code>indexer</code> - narzędzie do tworzenia pełnotekstowych indeksów (indices);
sphinx-quickstart
+
* <code>searchd</code> - demon do przeszukiwania indeksów przez zewnętrzne aplikacji (np. skrypty www komunikujące się przez API, MySQ z SphinxSE itp.), jest uruchomiony na serwerze;
 +
* <code>sphinxapi</code> - zbiór bibliotek udostępniających API Sphinxa dla [[PHP]], [[Python]]a, [[Java|Javy]], Perla, czy [[Ruby|Rubiego]];
 +
* <code>spelldump</code> - proste narzędzie do wydobywania pozycji ze słownika ''ispell'' lub ''MySpell'' służące do dostosowania indexu;
 +
* <code>indextool</code> - program narzędziowy do zrzucania rozmaitych;
 +
* <code>wordbreaker</code> - program służący do rozdzielania połączonych wyrazów na oddzielne.
  
=== Struktura dokumentu ===
+
=== Odnośniki Zewnętrzne ===
 +
* [http://sphinxsearch.com/ Sphinx Search]
  
Skrypt <code>sphinx-quickstart</code> stworzył katalog z plikiem konfiguracyjnym <code class="directory>conf.py</code> i z głównym dokumentem <code class="directory>index.rst</code>. Zasadniczym zadaniem głównego dokumentu jest serwowanie strony, która zawiera listę
+
[[Kategoria:Bazy Danych]]
 
 
The main function of the master document is to serve as a welcome page, and to contain the root of the “table of contents tree” (or toctree). This is one of the main things that Sphinx adds to reStructuredText, a way to connect multiple files to a single hierarchy of documents.
 
 
 
=== Odnośniki zewnętrzne ===
 
[http://sphinx-doc.org/ Sphinx]
 
[[Kategoria:Python]]
 

Wersja z 20:27, 20 lip 2015

Sphinx to otwarty, w pełni tekstowy serwer wyszukiwania stworzony w C++ i udostępniony na licencji GPLv2. Najczęściej jest wykorzystywany do indeksowania danych z baz MySQL, PostreSQL i specjalnie sformatowanych plików xml.

Elementy Sphinxa

Sphinx składa się z następujących elementów:

  • indexer - narzędzie do tworzenia pełnotekstowych indeksów (indices);
  • searchd - demon do przeszukiwania indeksów przez zewnętrzne aplikacji (np. skrypty www komunikujące się przez API, MySQ z SphinxSE itp.), jest uruchomiony na serwerze;
  • sphinxapi - zbiór bibliotek udostępniających API Sphinxa dla PHP, Pythona, Javy, Perla, czy Rubiego;
  • spelldump - proste narzędzie do wydobywania pozycji ze słownika ispell lub MySpell służące do dostosowania indexu;
  • indextool - program narzędziowy do zrzucania rozmaitych;
  • wordbreaker - program służący do rozdzielania połączonych wyrazów na oddzielne.

Odnośniki Zewnętrzne