Shapely: Automatische Dokumenterstellung

Erstellt am 27. Okt. 2015  ·  6Kommentare  ·  Quelle: Toblerity/Shapely

Automatisieren Sie unseren Dokumenterstellungs- und Veröffentlichungsworkflow mit dem Bereitstellungssystem von Travis.

Siehe auch Nr. 336.

documentation enhancement

Hilfreichster Kommentar

Sie möchten auch das Bewusstsein für https://github.com/drdoctr/doctr schärfen, wenn Sie die Dokumente auf der Travis-Route durchgehen.

Alle 6 Kommentare

Matplotlib macht das übrigens schon. Siehe https://github.com/matplotlib/matplotlib/blob/master/.travis.yml#L126

Ich denke aber, dass der Prozess verbessert werden könnte...

Außerdem habe ich gerade herausgefunden, dass ReadTheDocs jetzt Conda-Installationen durchführen kann, was RTD zu einer praktikablen Option für die Erstellung von Shapely-Dokumenten macht (ich habe mit einigem Erfolg einen Proof of Concept für Cartopy durchgeführt).

Ich habe es versucht und habe etwas funktioniert, basierend auf diesem Tutorial: https://gist.github.com/domenic/ec8b0fc8ab45f39403dd

Die Änderungen sind hier: https://github.com/Toblerity/Shapely/compare/master...snorfalorpagus :autodoc

Der Prozess erfordert, dass Sie ein neues SSH-Schlüsselpaar erstellen und eine verschlüsselte Version des privaten Schlüssels in das Repo / Travis einfügen.

Es ist so eingerichtet, dass die Dokumentation nur in einer Instanz erstellt wird (Python 3.5 mit Beschleunigungen). https://travis-ci.org/snorfalorpagus/Shapely/jobs/177188968

Dies hat deutlich gemacht, dass einige der Skripte, die Abbildungen in der Dokumentation erstellen, nicht mit Python 3.x kompatibel sind, z. B. buffer.py, was Folgendes ergibt:

Traceback (most recent call last):
  File "buffer.py", line 29, in <module>
    ax.set_xticks(range(*xrange) + [xrange[-1]])
TypeError: unsupported operand type(s) for +: 'range' and 'list'

@snorfalorpagus Bevor Sie mehr Zeit damit verbringen, lassen Sie mich prüfen, ob unsere Manylinux1-Räder dazu beitragen, readthedocs zu einer besseren Option zu machen.

Sie möchten auch das Bewusstsein für https://github.com/drdoctr/doctr schärfen, wenn Sie die Dokumente auf der Travis-Route durchgehen.

Ich verschiebe das auf den nächsten Meilenstein. Ich möchte 1.6.0 entsperren und danach an der Doc Infra arbeiten.

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen

Verwandte Themen

FuriousRococo picture FuriousRococo  ·  5Kommentare

jGaboardi picture jGaboardi  ·  5Kommentare

MarkWieczorek picture MarkWieczorek  ·  4Kommentare

LostFan123 picture LostFan123  ·  3Kommentare

dopplershift picture dopplershift  ·  3Kommentare