Mit Sphinx schreiben persönliche Websites und Blogs

Question

Sphinx ist eine Python-Bibliothek schöne Dokumentation von einer Reihe von ReST Textdateien formatiert.

Ich frage mich, wenn jemand Sphinx Plugins geschrieben hat, um es erzeugen persönliche Websites und Blogs .

Speziell für Blogs, muss es automatisch Liste Beiträge einen Weg, um chronologisch und erzeugen einen RSS-Feed. Man muss schreiben eine Sphinx-Plugin Spezialseite / xml Generation zu tun.

Hat jemand versucht, dies vor?

Answer 1

Ich habe es getan unter http://reinout.vanrees.org/weblog . Der Schlüssel Trick ist, einen Präprozessor Schritt hinzuzufügen. Ich habe meine Blog-Einträge in einer weblog/yyyy/mm/dd/ Ordnerstruktur bekomme.

Ein Skript iteriert durch diese Ordnerstruktur, index.txt Dateien in jedem Verzeichnis erstellen, die Auflistung der Unterpunkte. Der normale Sphinx Prozess dann macht diese index.txt Dateien.

habe ich einen benutzerdefinierten Sphinx Prozessor für Tags. So ".. Tags :: Python, buildout" irgendwo an der Spitze von meinem Weblog-Eintrag erzeugt die Tags. Und der Prä-Prozessor sammelt wieder die Einträge und schreibt eine weblog/tags/TAGNAME.txt Datei, die Sphinx wieder normal macht.

Der Präprozessor schafft auch die Wurzel weblog/index.txt mit den neuesten 10 Einträge. Und ein weblog/atom.xml in (fest einprogrammiert) das Ausgabeverzeichnis für den RSS-Feed.

Also: Sie müssen einige benutzerdefinierte Sachen, aber es ist ziemlich Klartext, so für mich ist es eine nette Übung war. Und Sie bekommen ein paar Helfer-Skripte zu schreiben, das Leben zu erleichtern, zum Beispiel eines, die Kopien eine Text-Datei von irgendwo auf dem heutigen Weblog-Verzeichnis (einschließlich der Erstellung von fehlenden Verzeichnissen und ein „svn add“).

Answer 2

Ab jetzt (Februar 2012), gibt es verschiedene Mittel zur Verfügung zu tun, was Sie wollen:

Ein Blog-Engine basiert auf Sphinx: http://tinkerer.me/

Reinout Van Rees' Blog: https://github.com/reinout/reinout.vanrees.org

Der Vorschub contrib Erweiterung: https://bitbucket.org/birkenfeld/sphinx-contrib/ src / tip / feed / README

Answer 3

Doug Hellmann, Autor der ‚Python-Modul der Woche‘ hat seine Website mit Sphinx.

http://www.doughellmann.com/PyMOTW/

Er hat mehrere Stellen, die Abdeckung Sphinx Themen, die wahrscheinlich auf dem Weg helfen kann:

http://blog.doughellmann.com

Answer 4

Wenn Sie schreiben müssen, in reStructuredText , sollten Sie versuchen, Pelican .

Pelikan ist ein statische Website-Generator, in Python geschrieben. Sie werden in der Lage sein, um Ihre Blog-Einträge direkt in reStructuredText oder Abschriften zu schreiben.

Answer 5

Es lohnt sich zu wissen, dass es einen RSS-Erweiterung für sphinx in den Sphinx-contrib Erweiterungen, genannt sphinxcontrib.feed Es und viele andere lustige Sphinx Dinge leben unter http://bitbucket.org/birkenfeld/sphinx-contrib/

(Disclaimer:. Ich schrieb die Feed-Erweiterung)

Answer 6

Schauen Sie sich ABlog für Sphinx

Ich bin in dem Prozess ein Blog selbst es mit zu beginnen.

ich über sie gestolpert, während ich durch meinen Feeds in feedly ging. Ich suchte darüber nach und fand es interessant. Es hat auch Disqus Integration und kann Atom-Feeds Generat (nicht ganz sicher, was das ist im Moment, ich bin neu im Web)

Ich habe noch nicht herausgefunden, wie mein Test-Blog zu implementieren, wird aktualisiert, wenn ich etwas herausfinden.

Answer 7

Nicht Sphinx, aber einige der Websites unter http://codespeak.net/ sind mit Skripten durchgeführt, die nehmen ReST Text, erzeugt HTML und lädt sie auf der Website. Ich schrieb nicht diese Skripte zwar, aber ich habe sie genutzt.

Es ist eine vernünftige Art und Weise Webseiten zu erzeugen, wenn die Seiten viel Ruhe enthalten brauchen Dateien sowieso, wie wenn Dokumentation zu erzeugen, um Python-Modulen, die natürlich diese Seiten sind alle über. Es ist auch gut, wenn Sie die Website benötigen Version gesteuert zu sein, weil Sie den Quellcode in SVN oder hg halten können, oder so etwas.

Aber wenn Sie eine Menge von automatischen Menüs und anderen Erweiterungen Schreiben beginnen, was werden Sie am Ende mit in dem Ende ist ein Content-Management-System. Und es gibt viele Menschen in Ihrer Umgebung bereits, so dass Sie zuerst auf sich schauen interessiert sein könnten.

Ein weiteres Beispiel ist die neue packages.python.org. Dort können Sie Ihre Unterlagen erzeugen in irgendeiner Weise Sie es wollen, und dann durch PyPI laden Sie eine ZIP-Datei mit der Dokumentation. Verteilen Sie hat mit Sphinx dies getan: http://packages.python.org/distribute . Aber es kein bestimmtes Script benötigt wird, die gerade ist Generierung HTML von Sphinx-Dokumentation.

Allerdings ...

Ich muß sagen, dass ich die Idee des Schreibens eine Blogging-Software als Sphinx Erweiterung ein bisschen komisch finden, vor allem, da es so viel ausgezeichnet Blogging-Software bereits draußen. Und nichts wird Wordpress schlagen sowieso, und wordpress.com hat eine große Blogging-Erfahrung für mich. Aber als eine Übung in wie viel Sie Sphinx missbrauchen, warum nicht! : -)

Answer 8

ich umgestrickt meine persönliche Website ( http://homepage.mac.com/s_lott/steve/ ) in Sphinx. Es funktioniert gut. Leider ist die SO Markup Mangeln der _ in meiner URL.

Ich schrieb auch das gesamte Einführung in die Programmierung für Nicht-Programmierer ( http://homepage.mac.com/s_lott/books/nonprog/html/index.html ) Buch in Sphinx. Ich bin in dem Prozess Einführung in Python in Sphinx neu zu schreiben.

Ich verwende Sphinx nicht für Blogs - es ist nicht vollkommen, aber es funktionieren würde. Ich benutze spot für Low-Grafiken / high-Text und relativ hoher Geschwindigkeit Bloggens. Ich benutze iWeb ( http://web.me.com/s_lott/Travel/Welcome. html ) für hohe Grafik und relativ niedriger Geschwindigkeit Bloggens.