Tag: python-sphinx
Sphinx ist ein Werkzeug, das macht es einfach zu erstellen Sie intelligente und schöne Dokumentation. Sphinx eignet sich besonders für die Python-Dokumentation, aber es ist ein Allzweck-tool, das verwendet werden kann, zu dokumentieren nichts.
Was ist der Mathworks Weg zur Generierung von Matlab in der HTML-Dokumentation?
3 Antworten
Bin ich arbeiten auf gemeinsam genutzten Matlab-code, und wir möchten, zu teilen einer generierten Dokumentation als durchsuchbare HTML-Dokumente in unserem lokalen Netzwerk. Ich kenne die folgenden Methoden zum generieren einer Dokumentation: Schreiben Sie ein Programm, um C++-Dateien
Einfachste Weg zur Ausführung der Sphinx auf eine python-Datei
2 Antworten
Haben wir eine Sphinx-Konfiguration das wird erzeugen eine Menge von HTML-Dokumenten für unsere gesamte Codebasis. Manchmal arbeite ich auf die eine Datei und ich möchte nur, um zu sehen, die HTML-Ausgabe aus dieser Datei, um sicherzustellen, habe
Sphinx: so schließen Sie die Importe in automodule?
3 Antworten
Ich habe ein Raspberry Pi Projekt, geschrieben in Python, benutzt RPi.GPIO-Modul. Alle arbeiten am code erfolgt auf einer Windows box, wo der RPi.GPIO nicht installieren und jedes mal, wenn ich versuche zu laufen autodoc stürzt es ab,
Wie generieren Sie Microsoft Word-Dokumente mit Sphinx
8 Antworten
Sphinx unterstützt einige Ausgabe Formate: Mehrere HTML-Dateien (mit html oder dirhtml) Latex, die nützlich für die Erstellung von .pdf oder .ps text Wie bekomme ich die Ausgabe in eine Microsoft Word-Datei statt? Mit anderen doc-generator habe ich
RESTful-web-service-API-Dokumentation mit Sphinx
2 Antworten
Geschlossen. Diese Frage ist off-topic. Es ist derzeit nicht akzeptieren Antworten. mehr. verbessern Wollen dieser Frage? "Update" die Frage so ist es on-topic für Stack-Überlauf. Geschlossen letztes Jahr. Was ist der beste Weg, um markup-Methoden/- URLs für
Die Kombination von Sphinx Dokumentation von mehreren Teilprojekten: Umgang mit Indizes, die Synchronisierung Konfiguration, etc
2 Antworten
Haben wir ein multi-Modul-Projekt dokumentiert mit dem (hervorragenden) Sphinx. Unser setup ist nicht anders als eine wie auf der mailing-Liste. Insgesamt funktioniert Super! Aber wir haben ein paar Fragen über das tun so: Dem Submodul Inhaltsverzeichnisse gehören
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,
Verknüpfung von source-code-Datei im sphinx
3 Antworten
Dokumentiere ich ein python-Modul in der Sphinx. Ich habe einen source-code-Datei voll von Beispielen für die Nutzung von my-Modul. Ich möchte auf diese Datei verweisen. Es ist zu lang, um als kontinuierliche inline-code. Gibt es eine Möglichkeit
Wie express mehrere Arten für einen einzelnen parameter oder Rückgabewert in docstrings, die verarbeitet werden, Sphinx?
1 Antworten
Manchmal eine Funktion in Python kann akzeptieren ein argument ein flexibler Typ. Oder es kann einen Wert zurückgeben, der eine flexible Art. Jetzt kann ich mich nicht erinnern, ein gutes Beispiel für eine solche Funktion jetzt, also
'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
Wie Sie richtig schreiben, Verweise auf externe Dokumentationen mit intersphinx?
5 Antworten
Ich versuche, fügen Sie Verweise auf externe API in meine Unterlagen, aber ich bin vor drei verschiedene Verhaltensweisen. Ich bin mit sphinx(1.3.1) mit Python(2.7.3) und meine intersphinx mapping konfiguriert ist als: { 'python': ('https://docs.python.org/2.7', None), 'numpy': ('http://docs.scipy.org/doc/numpy/',
Wie Sie verschiedene Rückgabetypen in python docstring
1 Antworten
Ich bin derzeit beim schreiben von Dokumentation für meine python-Paket mit der Sphinx und dem autodoc-plugin. Für den Rückgabewert einer Funktion kann ich z.B. schreiben :returns: int: count die sphinx erzählt, dass es einen Rückgabewert vom Typ
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
Sphinx für php-code-Dokumentation
5 Antworten
Sphinx ist eine Python-Bibliothek zu generieren, die schöne Dokumentation aus einer Reihe von ReST-formatierten text-Dateien. Nicht das tool für die Volltextsuche Ich bin auch voll und ganz bewusst, doxygen /phpdoc-tools. Ich versuche herauszufinden, ob es ist 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 machen wir das einbetten von Bildern in sphinx docs?
2 Antworten
Ich bin ganz neu in der Verwendung von sphinx, Tut-Dokumentation zum ersten mal für das python-Projekt. Wie auf Bild einbetten zum Beispiel in der sphinx-Dokumentation ? InformationsquelleAutor Ciasto piekarz | 2014-09-16
OS X installieren der Sphinx: Die sphinx-build' und 'sphinx-quickstart' nicht gefunden
4 Antworten
Gab es mehrere 'unbeantwortet' - postings dieses Thema betreffend finden "sphinx-build' nicht in der Lage zu finden: sphinx-build-h Befehl nicht gefunden in Mac OS Sphinx war installiert auf OSX mit beiden: python3 -m pip install sphinx brew
Wie man eine interne hyper-link in der sphinx-Dokumentation
1 Antworten
Wie man eine interne hyper-link in der sphinx-Dokumentation? Ich bin mit: :role:`target` Aber es funktioniert nicht. Die :role:‘target‘ Nomenklatur ist fast richtig. Sie müssen nur backticks (d.h., :role:`target`) statt single quotes. InformationsquelleAutor ajax-ie | 2010-12-08
python-sphinx: wie um zu zeigen, linux-Befehl code-snippets
3 Antworten
Mit sphinx, ich weiß, Sie können zeigen, ein Stück python-code-snippet oder ruby-code-snippet ein, indem Sie mit so etwas wie: .. code-block:: ruby. ${your ruby code goes here} Wie kann ich ein code-snippet linux-Befehle oder nur einige Konsolen-Befehle,
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
Sphinx PDF Themen
2 Antworten
Tut die Sphinx documentation tool bieten verschiedene PDF-Themen, wie es bietet verschiedene HTML-themes? Googelte ich das Problem aber nicht finden können, eine Antwort, das führt mich zu glauben, dass die Antwort 'Nein'. Noch, ich dachte, ich würde
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
Wie die toctree in der sidebar auf jeder Seite
2 Antworten
Ich bin generieren der html-Dokumentation in der Sphinx. Wie ändere ich die sidebar für jede der html-Seiten in meinem Dokument so, dass die toctree? Standardmäßig ist die toctree scheint nur die Anzeige in der master_doc Seite, und
Sphinx, mit automodule zu finden Submodule
2 Antworten
Bei der Verwendung von sphinx ' s automodule (http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule), Ich einfach schreiben .erste Datei: .. automodule:: my_module :members: Dokumente my_module in Ordnung, aber es nicht die inneren Module wie my_module.inner_module0 und my_module.inner_module1. Gibt es etwas, das muss
Hinzufügen von benutzerdefinierten css-Datei zu Sphinx?
3 Antworten
Wie kann ich das hinzufügen von benutzerdefinierten css-Datei? Folgende config funktioniert bei mir nicht: # conf.py html_static_path = ['_static'] html_theme = 'default' html_theme_options = { 'cssfiles': ['_static/style.css'] } Ergebnis: C:\temp\test-docs\docs>make html Running Sphinx v1.2.2 loading pickled environment...
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,
In Python, sphinx, wie Sie eine Verknüpfung zu einer Datei in _static-Verzeichnis
2 Antworten
Habe ich einige code-und Daten-samples, die ich kopieren _static Verzeichnis und ich würde gerne den link zu diesen Dateien in der Dokumentation, so etwas wie: .. _pca-run.py: _static/example.data Aber das problem ist, dass sphinx nicht erstellen Sie
Sphinx Fehler: Unbekannte Direktive geben "automodule" oder "autoclass"
1 Antworten
Muss ich mein Dokument-Python-Projekt mit dem Sphinx. Aber ich kann nicht mit autodoc. Wenn ich config mein Projekt wähle ich die option "Erweiterung autodoc", aber jetzt, wenn ich .. autoclass:: Class Bekomme ich eine Fehlermeldung: ERROR: Unknown
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,
Das sphinx-build " - Kommando nicht gefunden wurde.
3 Antworten
Dies war unsere Prozesse von der Installation von Sphinx. > choco install python -y -f > pip install sphinx Wissen wir, dass die sphinx installiert, weil der folgenden Ausgabe. > pip show sphinx --- Metadata-Version: 2.0 Name:
So erstellen Sie eine PDF-aus-der-Sphinx-Dokumentation-Werkzeug
4 Antworten
Folgte Sie diesem link, um zu versuchen und generieren von pdf-Sphinx: https://www.quora.com/How-to-create-a-PDF-out-of-Sphinx-documentation-tool $ sphinx-build -b pdf source build/pdf Error: Cannot find source directory `/Users/seb/mydocs/source'. $ make all-pdf make: *** No rule to make target `all-pdf'. Stop. $
Was sind die wichtigsten Unterschiede der Sphinx und Doxygen?
1 Antworten
Möchte ich zur Vorbereitung einer Dokumentation für eine Sammlung von Projekten, Modulen und Bibliotheken auf dem Gebiet der computer vision (meist in c++ geschrieben). Zu diesem Zweck hatte ich einen Blick auf die OpenCV-Dokumentation und wie Sie
Die Sphinx code-block zu verwendende Sprache für JSON
5 Antworten
Ich bin mit Sphinx-Dokument eines web service. Ich möchte eine formatierte JSON-web-Antwort mit dem code-block-Direktive, die Spinx über die Pygments, doch JSON hat keinen syntax-highlighter in Pygments. Welche Sprache schlagen Sie vor, ich geben Sie statt dessen?
Relative Importe erfordern das 'Paket' - argument
3 Antworten
Will ich mit der Sphinx, so kann es automatisch eine pydoc für mein python-code, aber ich erhalte eine Fehlermeldung. Ein was ich falsch mache? conf.py sphinx config-Datei import sys import os from django.conf import settings os.environ['DJANGO_SETTINGS_MODULE'] =
Wie dokumentieren Python-Funktion Parameter mit sphinx-apidoc unterbreitet
2 Antworten
Ich versuche es zu bereinigen, meine python-code-Dokumentation, und beschlossen,sphinx-docweil es gut aussieht. Ich mag, wie ich den Verweis auf andere Klassen und Methoden mit tags wie: :class:`mymodule.MyClass` About my class. :meth:`mymodule.MyClass.myfunction` And my cool function Ich versuche,
Wie zu verwenden Sphinx autodoc zum Dokument einer Klasse die __init__(self) Methode?
3 Antworten
Sphinx nicht erzeugen docs für die __init__(self) standardmäßig. Ich habe versucht, die folgenden: .. automodule:: mymodule :members: und ..autoclass:: MyClass :members: In conf.py die Einstellung der folgenden nur hängt die __init__(self) docstring der Klasse docstring (die Sphinx
Sphinx nicht gefunden wird Python-Paketen bei der Verwendung von autodoc
1 Antworten
Ich versuche, Erstellung der Dokumentation für test-Python-Projekt, bevor Sie es für das eigentliche Projekt. Mein system : Win7 64-bit, python 2.7.5 64 bit. Mein Projekt name ist testDoc. Es enthält python-Packung, namens tumfasst 2 Module t1 und
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
Wie force Sphinx zu verwenden Python 3.x-interpreter
8 Antworten
Ich versuche, Erstellung der Dokumentation für ein Projekt geschrieben mit Python 3.x. Sphinx ist die tool, das ich verwenden möchten, und, entsprechend der offizielle Websitedessen Letzte version 1.1.2 ist kompatibel mit Python 3.1+. Mein Betriebssystem ist Archlinux,
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
Sphinx mit Markdown anstelle von RST verwenden
9 Antworten
Ich hasse ERSTEN sondern Liebe sphinx. Gibt es eine Möglichkeit, die sphinx liest markdown anstelle von reStructuredText? InformationsquelleAutor der Frage digi604 | 2010-03-18
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
Autodokumentation von Python mit Sphinx
5 Antworten
Dies ist eine verallgemeinerte version des Vorherige Frage bezüglich der Sphinx. Gibt es eine Möglichkeit, rekursiv autodocument Module oder packages, die Klassen enthalten, und Funktionen, die in Ihnen? Ich denke, es ist albern, fügen Sie die autofunction
Wie dokumentiert man Python-Code mit doxygen?
5 Antworten
Ich wie doxygen zur Erstellung der Dokumentation von C oder PHP-code. Ich habe eine bevorstehende Python-Projekt und ich denke, ich erinnere mich, dass Python nicht /* .. */ Kommentare, und hat auch seine eigene selbst-Dokumentation Anlage, die
Link zur Klassenmethode in Python-Docstring
3 Antworten
Ich einen link hinzufügen möchten, auf eine Methode in meine Klasse innerhalb der docstring einer anderen Methode der selben Klasse. Ich will den link zu der Arbeit in der sphinx und bevorzugt auch im Spyder und anderen
sphinx-build fail - autodoc kann das Modul nicht importieren / finden
7 Antworten
Ich versuche, um loszulegen mit Sphinx und scheinen unerbittliche Probleme. Befehl: docs/sphinx-quickstart Ich alle Fragen beantworten und alles funktioniert einwandfrei. Befehl: docs/ls Sieht alles ganz normal aus. Ergebnis: build Makefile source Befehl: sphinx-build -d build/doctrees source build/html
- 1
- 2