Sphinx, der Doku-Generator

[birkenfeld]

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

Announcement: hier
Website: hier

[BlackJack]

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.

[Trundle]

Bei mir funktioniert die Seite wunderbar mit konqueror.

[birkenfeld]

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?

[BlackJack]

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

[lunar]

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]

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]

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.

[birkenfeld]

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.

[birkenfeld]

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.

[lunar]

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

[birkenfeld]

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

[Leonidas]

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?

[gerold]

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!

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

[lunar]

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.

[gerold]

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

Hallo lunar!

Ja, aber der IE7 wird doch nicht JavaScript generell verbieten. Das wäre ja Schwachsinn. Also muss es irgend etwas mit dem dort verwendeten JavaScript auf sich haben. :K

lg
Gerold

[lunar]

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

Ja, aber der IE7 wird doch nicht JavaScript generell verbieten. Das wäre ja Schwachsinn. Also muss es irgend etwas mit dem dort verwendeten JavaScript auf sich haben. :K

Es lädt den Suchindex nach, und durchsucht ihn nach den übergebenen Phrasen... mehr macht das nicht. Eventuell stört sich de IE 7 ja am Nachladen. Ich sehe an dem Skript zumindest nichts gefährliches

Bleibt, die Sicherheitseinstellungen des IE durchzugehen, und per Trial & Error den Verursacher der Warnung herauszufinden. Viel Spaß dabei

[gerold]

Hallo!

Die Meldung im IE7 lautet:

Das Ausführen von Skripts bzw. ActiveX-Steuerelementen die auf dem Computer zugreifen können wurde für diese Webseite aus Sicherheitsgründen eingeschränkt.

Die Sicherheitseinstellungen des IE7 wurden nicht verändert. Die Seite wird "lokal" aufgerufen.

Das merkwürdige daran ist, dass http://docs.python.org/dev/ diese Meldung nicht bringt. Auch wenn man eine der Seiten herunterläd und lokal aufruft, kommt die Meldung nicht. Die Meldung kommt nur mit der lokal generierten HTML-Seite.

Es gibt allerdings keine Unterschiede was die JavaScripts betrifft. Beide werden gleich aufgerufen und ein DIFF bringt keine Unterschiede zu tage.

Code: Alles auswählen

    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/interface.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>

Ich tu das jetzt als weiteren Bug des IE7 ab und befasse mich nicht mehr damit. Dieses sch... Ding kommt mir sicher nicht auf die Platte.

lg
Gerold

[gerold]

Eventuell stört sich de IE 7 ja am Nachladen.

Hallo lunar!

Das wird's wahrscheinlich sein.

lg
Gerold