In vielen Django-Projekten kann ich im Verzeichnis docs * .rst-Dateien sehen:Durchsuchen (kein Texteditor) .rst-Dateien?
Was ist der beste Weg, um sie zu durchsuchen (ohne natürlich einen Texteditor zu verwenden)?
Ist das möglich, HTML zu generieren?
.rst Dateien sind ReStructuredText Format. Sie sehen wie Textdateien aus, können aber mit dem Python docutils-Paket in HTML gerendert werden.
This page beschreibt, wie Sie Djangos eigene Dokumentation über die Sphinx-Bibliothek in HTML erstellen können. Andere Projekte werden wahrscheinlich genauso funktionieren.
https://docs.djangoproject.com/en/1.8/internals/contributing/writing-documentation/ –
Während dies theoretisch die Frage beantworten könnte, [wäre es vorzuziehen] (http://meta.stackexchange.com/q/8259), um die wesentlichen Teile der Antwort hier einzubeziehen und den Link als Referenz bereitzustellen. –
Versuchen Wie ZJK sagt, Sie restview verwenden können:
restview ist aus dem Python Package Index zur Verfügung: http://pypi.python.org/pypi/restview. Sie können pip auch Restview installieren.
Hier ist, was ich tat, um es zu testen eine virtuelle Umgebung mit:
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
Dieser startete einen Web-Server und öffnete die Dokumentation Seite in meinem Browser.
Hinweis: Ich habe nur virtualenv verwendet, da ich es nicht mag, Dinge global zu installieren. Es mag für viele andere zu viel sein, aber ich habe auch mehr Glück mit diesen einmaligen Umgebungen. Als ich pip install restview auf einer Ubuntu 14.04 VM ausprobierte, scheiterte es, während der oben beschriebene Ansatz für mich sowohl auf diesem System als auch diesem einen Zauber wirkte.
benennen Sie die Dateiendung einfach in .txt um und öffnen Sie die Datei mit einem beliebigen Texteditor.
Menschen neigen dazu, Grenzen und Hindernisse zu setzen, um ihr Wissen zu verbergen - eine Zeitblasse.
Können Sie bitte die Beschreibung bearbeiten, um auf die "ohne einen Texteditor natürlich zu erweitern" zu erweitern? Das scheint ein guter Weg zu sein, und Ihre Gründe für die Ablehnung sind nicht klar. – bignose