Tag: restructuredtext
reStructuredText ist eine leichte markup-Sprache soll sehr gut lesbar im Quellcode-format.
Legen Sie den relativen link in reStructuredText
1 Antworten
Dokumentiere ich eine Bibliothek, eine Python-Komponente und eine JavaScript-Komponente. Die Allgemeine Benutzer-Dokumentation, und die Python-API-Dokumentation sind in reStructuredText, verarbeitet mit Sphinx. Die JavaScript-API ist in der jsdoc-und verarbeitet werden, mit jsdoc-toolkit. Der AUFTRAGGEBER Ausgabeformat HTML. Ich bin
Wie Schreibe ich das Multiplikationszeichen im reStructuredText (reST)?
4 Antworten
Ich Schreibe übrigen Dokumente, die gerendert wird in HTML-und PDF-Datei mit der Sphinx. Meine source-Dateien sind UTF-8, und erwarte, dass meine HTML angezeigt werden als UTF-8. Was ist die best practice für die schriftliche Multiplikation? Ist: x,
Wie kann ich eine benutzerdefinierte Fußzeile zu Sphinx-Dokumentation? (reStructuredText)
1 Antworten
Wenn ich einige Unterlagen, wie zum Beispiel Galleria Dokumentation, wie kann ich es so einrichten, dass wenn ich das make html Befehl wird es fügen Sie eine benutzerdefinierte Fußzeile auf jeder Seite? Sah ich, dass ich konnte
Bild-raster in reStructuredText / Sphinx
4 Antworten
Ich bin mit Sphinx erstellen von Dokumentationen für Python-Projekt, die ich arbeite. Ich habe drei Bilder, die ich möchte, um die Anzeige in einem 1x3 raster (D. H. alle auf der gleichen Linie), und ich versuche, herauszufinden,
Analyse reStructuredText in HTML
1 Antworten
Ich mache einen Rahmen, in dem ich damit die Entwickler beschreiben Ihr Paket mit reStructuredText. Ich möchte analysieren, die reStructuredText in HTML-so kann ich zeigen, dass es in einer GUI. Ich bin vertraut mit dem ausgezeichneten Sphinx,
'Unerwartete Abschnitt mit dem Titel' mit Sphinx — numpy ist das Problem?
1 Antworten
Beim laufen sphinx-build . html/ in meinem doc/ Verzeichnis, erhalte ich die folgende Ausgabe: $ sphinx-build . html/ Running Sphinx v0.6.4 No builder selected, using default: html loading pickled environment... done building [html]: targets for 0 source
Multi-line-Beschreibung der parameter Beschreibung in python docstring
5 Antworten
So, reStructuredText ist der empfohlene Weg für Python-code Dokumentation, wenn Sie hart genug versuchen, Sie können finden Sie in der sphinx-Dokumentation wie zu normalisieren Ihre Funktion Unterschrift-Dokumentation. Alle angegebenen Beispiele sind single-line, aber was ist, wenn ein
Gibt es echte alternativen zu reStructuredText für Python-Dokumentation?
7 Antworten
Ich ab, ein open-source-Python-Projekt in Kürze, und ich bin versucht, im Voraus zu entscheiden, wie das schreiben meiner docstrings. Die offensichtliche Antwort wäre, mit reStructuredText und Sphinx mit autodoc, weil ich wirklich mag die Idee einfach richtig
Wie Kommentar ein string im umstrukturiert text?
3 Antworten
Den Kommentar HTML ist <!-- .. -->, wie kann ich diese Kommentar-block mit restrukturiert text? Um die Worte, wie kann ich kommentieren, dass einige der Linien im umstrukturiert text? InformationsquelleAutor prosseek | 2011-01-24
Verweisen auf zahlen mit den zahlen in der Sphinx und reStructuredText
5 Antworten
Beim schreiben der ERSTEN, die verarbeitet werden, mit Sphinx, die ich nicht bekommen kann Sphinx LaTeX-Ausgabe zu verwenden-stelligen zahlen beim Bezug auf die zahlen. Zum Beispiel diesen code: The lemmings are attacking, as can be seen in
sphinx restructuredtext: set Farbe für ein einzelnes Wort
4 Antworten
Gibt es eine Möglichkeit, um die Farbe der einzelnen Wörter (oder Zeichen) in sphinx? Ich bin mir ziemlich sicher, sollte es eine markup-Tags, wie HTML - font tag. InformationsquelleAutor Adam Matan | 2010-09-13
Wie rechts-Ausrichtung der Spalten-Inhalt in reStructuredText einfachen Tabellen?
3 Antworten
Ich bin der Bearbeitung der Dokumentation für ein Projekt von mir mit Sphinx, die wiederum verwendet reStructuredText als markup-Sprache. Ich habe eine einfache Tabelle (im Gegensatz zu Tisch) in der am weitesten rechts liegenden Spalte Berichte enthält
Das einbetten von HTML in neu strukturierte text-Datei?
1 Antworten
Ich bin mit reStructuredText und ich möchte noch hinzufügen, HTML-Codierung eine interaktive flash-Typ-animation durch die <embed> tag. Aus meiner .erste Dokument, wie kann ich geben Sie die position dieser beliebigen chunk HTML? So etwas wie: .. html
ReST Durchgestrichen
4 Antworten
Ist es möglich, Streik text durch neu strukturierte Text? Etwas, das zum Beispiel macht so ein <strike> - tag bei der Konvertierung in HTML, wie: ReSTructuredText Wenn Sie die Sphinx, das könnte helfen: stackoverflow.com/a/24932178/2923406 InformationsquelleAutor gozzilli |
Wie kann ich den link/Verweis eine andere Datei in der Dokumentation?
4 Antworten
Ich habe einfach keine Idee, wie kann ich die Verknüpfung zu einem anderen Dokument in die reST-Datei. Möchte ich die Verknüpfung einer Datei mit dem Namen install.rst zu meinem quickstart guide in einem Absatz. Ich weiß nicht,
Multi-line-Zelle in reStructuredText?
2 Antworten
Gibt es eine Möglichkeit zur Eingabe eines Zeilenumbruchs in eine Zelle? Zum Beispiel, sagen wir ich habe eine Tabelle wie diese: +----------+----------+----------+ | Header 1 | Header 2 | Header 3 | +==========+==========+==========+ | Item 1 |
Wie würde ich das cross-Referenz-Funktion generiert autodoc in der Sphinx?
1 Antworten
Ich bin mit dem Sphinx autodoc Funktion zum generieren von Dokumentation basiert auf den docstrings meine Python-Bibliothek. Die syntax für cross-referencing ist gefunden hier Muss ein label vor dem Abschnitt, um zu ermöglichen, dass Abschnitt verwiesen werden,
Die Verwendung von Farben im text Umstrukturiert Text (rst2html.py) oder einfügen von HTML-tags ohne Leerzeilen?
3 Antworten
Wie kann ich die Farbe verwenden, mit Restrukturiert Text? Zum Beispiel **hello** übersetzt in <strong>hello</strong>. Wie kann ich neu Strukturieren(rst2html.py) übersetzen etwas in <font color="####">text</font>? Dachte ich über ..raw:: html, aber es bringt leere Zeilen. Ich möchte
einzelne py Datei konvertieren-rst to html
5 Antworten
Schreibe ich blog durch die Verwendung von rst, und ich manuell konvertieren Sie Sie in html und poste es. Für jetzt, ich möchten, erstellen Sie ein einfaches blog-system mit GAE, Ich weiß docutils kann konvertieren rst, html,
Hinzufügen einen Querverweis zu einer überschrift oder Anker in einer anderen Seite
3 Antworten
Wie Sie einen Querverweis einfügen in eine reST/Sphinx-Seite, um entweder ein sub-header oder Anker in einer anderen Seite, in der gleichen Dokumentation? InformationsquelleAutor der Frage Sue Walsh | 2013-03-13
So erstellen Sie eine verschachtelte Liste in reStructuredText?
2 Antworten
Ich versuche, erstellen Sie eine korrekt verschachtelte Liste mit dem folgenden code (nach Sphinx und docutils docs): 1. X a. U b. V c. W 2. Y 3. Z Ich erwarten, daß dieses Ergebnis in zwei OLs
WARNUNG: Dokument ist nicht in einem Baum für die enthaltene Datei enthalten
3 Antworten
Ich bin immer die Warnung: WARNING: document isn't included in any toctree für Dateien, die im Dokument vorhanden sind, denn Sie wurden ausdrücklich einbezogen. Also ich habe die index Datei: .. toctree:: :maxdepth: 2 pages/0010-foo pages/0020-bar In
PyCharm Änderung Dateityp Assoziation
3 Antworten
Ich habe eine Datei in PyCharm und seine verwendet werden, um nur ein .txt - Datei. Jetzt wollte ich .rst (reStructuredText). Ich weiß, dass wenn ich eine Datei öffnen ohne Ende zum ersten mal PyCharm fragt mich,
Wie dokumentiert man eine Modulkonstante in Python?
5 Antworten
Ich habe ein Modul, errors.py in denen mehrere Globale Konstanten definiert sind (Anmerkung: ich verstehen Sie, dass Python nicht Konstanten, aber ich habe Sie definiert hat per Konvention mit GROßBUCHSTABEN). """Indicates some unknown error.""" API_ERROR = 1
Mathe in reStructuredText mit LaTeX
12 Antworten
Ich würde gerne eine leichte markup-Sprache, um sich Notizen zu machen, die in meiner college-Klassen. Mein editor der Wahl ist gedit, und ich fand reStructuredText-Tools für Geditdie den reStructuredText-Prozessor und Rendern des HTML-Codes in einem Bereich, in
Einfachste Möglichkeit, ein Release in einer JAR-Datei zusammenzuführen
13 Antworten
Gibt es ein tool oder Skript, das leicht führt eine Reihe von GLAS Dateien in eine JAR-Datei? Ein bonus wäre ganz einfach die main-Datei manifest und machen Sie es ausführbar. Konkreten Fall ist ein Java umstrukturiert text-Werkzeug.
Inline-Code-Hervorhebung in reStructuredText
1 Antworten
Ich weiß reStructuredText hat diese Richtlinie: .. code:: bash gedit pohl.m rendert einen code-block. Gibt es eine Möglichkeit, um die Hervorhebung der syntax für die inline-snippets wie dieses: Do edit the file, type ``gedit pohl.m`` into a
Habe die gleiche README sowohl in Markdown als auch in reStructuredText
8 Antworten
Habe ich ein Projekt gehostet auf GitHub. Für diese habe ich geschrieben das mein README mit der Markdown-syntax, um es schön formatiert auf GitHub. Da mein Projekt ist in Python Plane ich auch hochladen PyPi. Die verwendete
Vergleichen und kontrastieren Sie die leichtgewichtigen Auszeichnungssprachen
5 Antworten
Bitte identifizieren Sie die beliebtesten lightweight markup-Sprachen und vergleichen Sie Ihre stärken und Schwächen. Diese Sprachen werden Allgemeine markup für die technische Prosa, wie für die Dokumentation (Z. B. Haml zählt nicht). Siehe auch: Bewertungsabschlag gegenüber ReStructuredText
Wie mache ich einen Link zu einer Datei mit sphinx?
1 Antworten
Schreibe ich eine Dokumentation, und ich möchte auch links zu pdf-Dateien oder zip-Archive. Wie kann ich erreichen, dass mit ersten Sprache und der sphinx ? Wenn ich das Tue, here is a pdf file : `pdf <doc/mypdf.pdf>`_