Sphinx, der Doku-Generator

Stellt hier eure Projekte vor.
Internetseiten, Skripte, und alles andere bzgl. Python.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Sphinx, der Doku-Generator

Beitragvon birkenfeld » Sonntag 23. März 2008, 07:58

Die Library hinter der neuen Python-Doku ist jetzt auch für andere Projekte benutzbar.

Announcement: hier
Website: hier
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
BlackJack

Beitragvon BlackJack » Sonntag 23. März 2008, 10:19

Was zum Henker wird da eigentlich mit JavaScript gemacht!? Jedesmal wenn ich auf so eine Seite gehe blockiert der Konqueror für ein paar Sekunden wobei ein Kern zu 100% ausgelastet wird. Damit ist die Doku in dem Browser nervig bis unbrauchbar. :-(
Benutzeravatar
Trundle
User
Beiträge: 591
Registriert: Dienstag 3. Juli 2007, 16:45

Beitragvon Trundle » Sonntag 23. März 2008, 11:43

Bei mir funktioniert die Seite wunderbar mit konqueror.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Beitragvon birkenfeld » Sonntag 23. März 2008, 13:07

BlackJack hat geschrieben:Was zum Henker wird da eigentlich mit JavaScript gemacht!? Jedesmal wenn ich auf so eine Seite gehe blockiert der Konqueror für ein paar Sekunden wobei ein Kern zu 100% ausgelastet wird. Damit ist die Doku in dem Browser nervig bis unbrauchbar. :-(


Hm, das ist ein neues Phänomen. Welche Version von Konqueror ist das?
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
BlackJack

Beitragvon BlackJack » Sonntag 23. März 2008, 14:15

Mein Konqi hat die Version 3.5.6. Vielleicht liegt's ja auch am Browser.
lunar

Beitragvon lunar » Sonntag 23. März 2008, 16:52

Ich bin noch nicht dazu gekommen, es zu testen, aber schon zwei Dinge, die mir beim Bauen des ebuilds aufgefallen sind:
  1. Hat es einen tieferen Sinn das Sphinx sein eigenes Jinja mitbringt? Immerhin ist Jinja ebenfalls Bestandteil des Cheeseshop, und für manche Distributionen gibt es auch Pakete.
  2. scripts oder entrypoints, ihr solltet euch für eine Version entscheiden. Momentan werden die Scripts nämlich zweimal installiert, einmal mit .py durch distutils und einmal ohne .py durch die Setuptools Entrypoints.


Nicht nur, dass es reichlich nervig ist, es macht das Bauen eines ebuilds auch nicht gerade leichter, immerhin muss ich das alles Rauspatchen.
Y0Gi
User
Beiträge: 1454
Registriert: Freitag 22. September 2006, 23:05
Wohnort: ja

Beitragvon Y0Gi » Sonntag 23. März 2008, 16:57

Sehr schön, Gratulation und Danke!

Das Logo erinnert mich irgendwie an Neverwinter Nights, oder wie das Spiel heißt ...

Wie weit ist `autodoc`? Welches Modul/Paket wird für Coverage benutzt, das von Ned Batchelder?
lunar

Beitragvon lunar » Sonntag 23. März 2008, 18:36

http://paste.pocoo.org/show/35137

Für alle Gentooianer. Ich habe allerdings die doppelte Installation der Skripte entfernt, ebenso wie ich Jinja aus dem Source-Tree gelöscht habe. Jinja wird als Abhängigkeit mitinstalliert, den dazu passenden ebuild gibt es im Gentoo Bugtracker.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Beitragvon birkenfeld » Sonntag 23. März 2008, 18:40

lunar hat geschrieben:Hat es einen tieferen Sinn das Sphinx sein eigenes Jinja mitbringt? Immerhin ist Jinja ebenfalls Bestandteil des Cheeseshop, und für manche Distributionen gibt es auch Pakete.

Natürlich hat es einen Sinn. Zumindest hatte es einen... für 0.2 könnte es anders aussehen.
scripts oder entrypoints, ihr solltet euch für eine Version entscheiden. Momentan werden die Scripts nämlich zweimal installiert, einmal mit .py durch distutils und einmal ohne .py durch die Setuptools Entrypoints.

Danke, fixed.
Nicht nur, dass es reichlich nervig ist, es macht das Bauen eines ebuilds auch nicht gerade leichter, immerhin muss ich das alles Rauspatchen.

Du tust mir ja leid ;) Soweit, um in ein ebuild zu kommen, ist es IMO eh noch nicht.
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Beitragvon birkenfeld » Sonntag 23. März 2008, 18:41

Y0Gi hat geschrieben:Sehr schön, Gratulation und Danke!

Das Logo erinnert mich irgendwie an Neverwinter Nights, oder wie das Spiel heißt ...

Kenn ich nicht :)
Wie weit ist `autodoc`? Welches Modul/Paket wird für Coverage benutzt, das von Ned Batchelder?

Nö, da geht es um Doc Coverage, sprich, was ist dokumentiert, nicht, was wird ausgeführt.
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
lunar

Beitragvon lunar » Sonntag 23. März 2008, 18:46

birkenfeld hat geschrieben:Nicht nur, dass es reichlich nervig ist, es macht das Bauen eines ebuilds auch nicht gerade leichter, immerhin muss ich das alles Rauspatchen.

Du tust mir ja leid ;) Soweit, um in ein ebuild zu kommen, ist es IMO eh noch nicht.

Weißt du, ich will das Ding ja auch wieder sauber löschen können, wenn es mir nicht gefällt ;)
Zuletzt geändert von lunar am Sonntag 23. März 2008, 18:57, insgesamt 1-mal geändert.
Benutzeravatar
birkenfeld
Python-Forum Veteran
Beiträge: 1603
Registriert: Montag 20. März 2006, 15:29
Wohnort: Die aufstrebende Universitätsstadt bei München

Beitragvon birkenfeld » Sonntag 23. März 2008, 18:50

Stimmt. Leider hat es der Easter Eby ja wieder nicht geschafft, uns einen Eierentferner ins Nest zu legen...
Dann lieber noch Vim 7 als Windows 7.

http://pythonic.pocoo.org/
Benutzeravatar
Leonidas
Administrator
Beiträge: 16023
Registriert: Freitag 20. Juni 2003, 16:30
Kontaktdaten:

Beitragvon Leonidas » Sonntag 23. März 2008, 19:04

birkenfeld hat geschrieben:Stimmt. Leider hat es der Easter Eby ja wieder nicht geschafft, uns einen Eierentferner ins Nest zu legen...

Mir fällt da ``easy_fucking_uninstall`` ein, von wem das ist könnt ihr euch ja denken ;)

Oh man, der Typ schaffts nicht brauchbare Links in sein Blog zu machen, oder?
My god, it's full of CARs! | Leonidasvoice vs Modvoice
Benutzeravatar
gerold
Python-Forum Veteran
Beiträge: 5554
Registriert: Samstag 28. Februar 2004, 22:04
Wohnort: Telfs (Tirol)
Kontaktdaten:

Beitragvon gerold » Mittwoch 14. Mai 2008, 11:30

Hallo!

Ich lasse Sphinx gerade bei uns in der Firma testen, um herauszufinden, ob man damit auch unsere Programmdokumentation umsetzen und ins Internet stellen kann. Danke für dieses Tool, birkenfeld! :D

Aber wie es immer so ist, habe ich zwei Punkte, die von unserem Supportmitarbeiter (der beauftragt wurde, Sphinx zu erkunden) noch nicht geklärt werden konnten.

Wenn man eine damit generierte HTML-Seite im Internet Explorer 7 öffnet, dann bekommt man oben eine Meldung eingeblendet, dass ein Skript oder AktiveX-Objekt geblockt wird. Warum auch immer. Ich konnte kein ActiveX-Objekt in der Seite finden, also schließe ich auf ein JavaScript. Aber mehr kann ich nicht herausfinden, da ich ein IE7-Verweigerer bin.

Und der zweite Punkt, der für uns interessant ist: Kann man mit Sphinx auf der linken Seite, dort wo derzeit der Table of Contents steht, auch einen "Table of Pages" einblenden? Einen "Table of Pages", der die aktuell betrachtete Seite hervorhebt? Gibt es so etwas bereits "Out of the box"? Oder wenn man sich das selber machen möchte, gibt es bereits existierende "Objekte", die man dafür verwenden kann und die Informationen über die aktuell angezeigte Seite zur Verfügung stellen?

Wie man sieht, habe ich mir den Quellcode noch nicht angesehen. ;-)

Danke,
Gerold
:-)
http://halvar.at | Kleiner Bascom AVR Kurs
Wissen hat eine wunderbare Eigenschaft: Es verdoppelt sich, wenn man es teilt.
lunar

Beitragvon lunar » Mittwoch 14. Mai 2008, 12:14

gerold hat geschrieben:Wenn man eine damit generierte HTML-Seite im Internet Explorer 7 öffnet, dann bekommt man oben eine Meldung eingeblendet, dass ein Skript oder AktiveX-Objekt geblockt wird. Warum auch immer. Ich konnte kein ActiveX-Objekt in der Seite finden, also schließe ich auf ein JavaScript. Aber mehr kann ich nicht herausfinden, da ich ein IE7-Verweigerer bin.

Das ist Java-Script, wird für die Suche benötigt.

Wer ist online?

Mitglieder in diesem Forum: 0 Mitglieder