Suchergebnisse für Anfrage "python-sphinx"

1 die antwort

Wie man Sphinx Respect dazu bringt, Klassen mit __init__.py in ein Paket zu importieren

Ich habe ein Paket: foofoo.pybar.py__init__.pyfoo.py hat eine Klasse Foo. In __init__.py importiere ich die Klasse Foo, damit Benutzer Folgendes tun können: from foo import FooSphinx dokumentiert Foo zu Recht als foo.foo.Foo, was zwar richtig, ...

1 die antwort

Wie deaktiviere ich Farben in LaTeX-Ausgaben, die mit Sphinx erstellt wurden?

Wenn ich die aus Sphinx generierte LaTeX-Datei erstelle, sind die Inhaltsverzeichniseinträge und Abschnittsüberschriften blau. Gibt es eine einfache Möglichkeit, das Färben dieser Objekte zu deaktivieren? Wenn nicht, gibt es eine einfache ...

1 die antwort

Wie verweise ich auf eine von autodoc in Sphinx generierte Funktion?

Ich benutze dieSphinx autodoc Funktion zum Generieren von Dokumentation basierend auf den Dokumentzeichenfolgen meiner Python-Bibliothek. Die Syntax für Querverweise wurde gefundenHier [http://sphinx-doc.org/markup/inline.html#ref-role] Vor dem ...

TOP-Veröffentlichungen

3 die antwort

Wie füge ich eine benutzerdefinierte CSS-Datei zu Sphinx hinzu?

Wie kann ich eine benutzerdefinierte CSS-Datei hinzufügen? Die folgende Konfiguration funktioniert bei mir nicht: # conf.py html_static_path = ['_static'] html_theme = 'default' html_theme_options = { 'cssfiles': ['_static/style.css'] ...

1 die antwort

Substitution in Ermahnungen

Wie kann ich eine Ermahnung ersetzen? Zum Beispiel: |p| account .. note:: **Been using |p| separately and now integrating?**In meiner sphinx conf.py definiere ich eine Ersetzungsregel, die vor der Interpretation an die erste Datei angehängt ...

3 die antwort

Welche Beziehung besteht zwischen docutils und Sphinx?

Es scheint eine Fülle von Dokumentationswerkzeugen für Python zu geben. Ein anderes, auf das ich gestoßen bin, ist epydoc. Es sieht so aus, als wäre Sphinx der De-facto-Standard, da hiermit die offiziellen Python-Dokumente erstellt werden. Kann ...

2 die antwort

Was bedeutet "Titelebene inkonsistent"?

Ich habe in meinen Dokumentationsbuilds Warnungen bezüglich der Sorte "Titelebene inkonsistent" erhalten. Soweit ich das beurteilen kann, habe ich eine konsistente Struktur, die ungefähr so aussieht: Big Title ========= Section ------- ...

4 die antwort

Getting Github einzelne Akte Mitwirkende

Ich plane, ein Plug-In für das Sphinx-Dokumentationssystem-Plug-In zu erstellen, das die Namen und Github-Profil-Links der Personen anzeigt, die zur Dokumentationsseite beigetragen haben. Github hat diese Funktion intern Ist es möglich, über ...

2 die antwort

Anker in beliebiger Position mit sphinx / reStructuredText?

Ist es möglich einen Anker hinzuzufügen (Linkziel, auf das ich mit @ verweisen ka:ref:) an einer beliebigen Stelle im Text? Ich habe eine Situation wie diese: Some text .. class:: mylist **Term 1** Definition *Term 2* ...

1 die antwort

Wie lasse ich die Werte von Variablen in Sphinx aus?

Ich habe einige Variablen auf Modulebene mit langen und uninteressanten Werten, die ich aus der automatisch generierten Dokumentation ausschließen möchte. Gibt es eine Möglichkeit, dies zu tun? Zum Beispiel habe ich in meiner Python-Quelle so ...