2010-04-05 11 views
26

W wielu projektach django, w katalogu docs widzę pliki * .rst:Jak przeglądać (bez edytora tekstu) pliki .rst?

Jaki jest najlepszy sposób ich przeglądania (bez korzystania z edytora tekstu oczywiście)?

Czy można wygenerować kod HTML? Pliki

+1

Czy możesz edytować opis, aby rozwinąć "bez korzystania z edytora tekstu"? To wydaje się być dobrym sposobem, a twoje powody odrzucenia go nie są jasne. – bignose

Odpowiedz

25

.rst są w formacie ReStructuredText. Wyglądają jak pliki tekstowe, ale mogą być renderowane do formatu HTML za pomocą pakietu Python docutils.

1

This page opisuje, jak zbudować własną dokumentację Django w HTML, za pośrednictwem biblioteki Sphinx. Inne projekty prawdopodobnie będą działać w ten sam sposób.

+0

https://docs.djangoproject.com/en/1.8/internals/contributing/writing-documentation/ –

5

Spróbuj restview

+10

Chociaż może to teoretycznie odpowiedzieć na pytanie, [byłoby lepiej (http://meta.stackexchange.com/q/8259), aby uwzględnić istotne części odpowiedzi tutaj i podać odnośnik dla odniesienia. –

11

Jak zjk mówi, można użyć restview:

restview jest dostępny od Indeksu pakiet Pythona: http://pypi.python.org/pypi/restview. Możesz także zainstalować restview.

Oto co zrobiłem, aby przetestować go przy użyciu wirtualnego środowiska:

mkdir restview 
cd restview/ 
virtualenv-2.7 venv # The second system I used just used 'virtualenv venv' 
./venv/bin/pip install restview 
./venv/bin/restview ~/path/MANUAL.rst 

ta uruchomiła serwer WWW i otworzył stronę dokumentacji w przeglądarce.

Uwaga: Używałem tylko virtualenv, ponieważ nie lubię instalować rzeczy na całym świecie. Może to być przesada dla wielu innych osób, ale mam też dużo szczęścia w tych jednorazowych środowiskach. Kiedy próbowałem pip install restview na maszynie wirtualnej Ubuntu 14.04, to się nie powiodło, podczas gdy powyższe podejście działało jak urok dla mnie w tym systemie, jak i tym.

-3

zmienić nazwę rozszerzenia pliku na .txt, a następnie otworzyć plik z dowolnym edytorem tekstu.

Ludzie mają tendencję do ustawiania granic i przeszkód, aby ukryć swoją wiedzę - talię czasu.

Powiązane problemy