documentation

12Hitze

1Antwort

Wie sphinx-generierte Dokumentation automatisch auf bitbucket Wiki veröffentlicht?

Ich habe ein Python-Paket mit Sphinx-generierte Dokumentation (mit der Automodules-Funktion) und es kann zu einer Reihe von statischen HTML-Seiten in einem _build-Verzeichnis im Git-Repository des Pro

documentation bitbucket python-sphinx 2013-02-19

---

6Hitze

4Antwort

Bedingte Toctree in Sphinx

Ich möchte mehrere Versionen einer Dokumentation, die sich in den Abschnitten, die enthalten sind, unterscheiden. Um dies zu erreichen, verwende ich normalerweise entweder die only Direktive oder die

documentation python-sphinx restructuredtext docutils 2013-02-21

---

6Hitze

4Antwort

Ausblenden von Sphinx-Unterabschnitten aus dem Haupt-TOCTree

Ist es möglich, einen (oder alle) in einer RST-Datei vorhandenen Unterabschnitte im Haupt-TOCTree auszublenden? Lassen Sie mich ein wenig mehr beschreiben: index.rst :doc:`Label <path/to/rst/file>` ^

documentation python-sphinx toc 2013-02-23

---

7Hitze

2Antwort

Sinatra Build REST API Dokumentation

Ich habe die ganze Nacht nach einem Juwel gesucht, um eine API-Dokumentation von meinen Sinatra-Routen zu generieren. Ich sollte in der Lage sein, mit Inline-Kommentaren anzugeben. Ich habe https://ru

ruby api rest documentation sinatra 2013-03-09

---

35Hitze

5Antwort

Erstellen Sie HTML-Dokumentation für C# -Code

Ich arbeite derzeit an einem C# -Projekt und VisualAssist generiert diese ausgefallenen /// <summary></summary> Kommentare für mich und ich habe sie verwendet dokumentieren meinen Code. Ich nehme an,

c# visual-studio documentation 2013-03-09

---

6Hitze

1Antwort

Selbstdokumentierende APIs basierend auf Django-Tastypie

Ich benutze django-tastypie und bin sehr zufrieden damit. Aber ich möchte wirklich die selbst dokumentierende API-Funktion von Django Rest Framework bekommen. Welche Lösungen gibt es (oder haben Leute

django api documentation tastypie 2013-03-11

---

24Hitze

1Antwort

Annotationsmethoden in Delphi?

Ich habe ein Stück Code, das einige ernsthafte Dokumentation benötigt und wollte fragen, ob eine für Embarcadero Delphi ähnliche Funktion wie C# /. NET In-Code-XML-Dokumentation verfügbar ist. Mein Zi

delphi documentation xml-documentation 2013-03-12

---

7Hitze

2Antwort

So dokumentieren Sie einen "Objekt" -Parameter einer Methode

Ich versuche, einige Dokumentation für eine JavaScript-Methode mit YUIDoc zu schreiben. Es sieht aus wie: /** Returns an instance of className @method getInstance @param {string} class

javascript documentation yuidoc 2013-03-13

---

6Hitze

1Antwort

man page synopsis notation

Beim Lesen von man pages, nach meiner Erfahrung gab es immer einen synopsis Abschnitt. z.B. MV(1) BSD General Commands Manual MV(1) NAME mv -- move files SYNOPSIS mv [-f | -i | -n] [-v]

documentation manpage 2013-03-17

---

18Hitze

1Antwort

Wie setze ich ein Eingabeverzeichnis für Doxygen?

Ich habe ein Verzeichnis, in dem alle Quell- und Header-Dateien gespeichert sind. Ich möchte Doxygen ausführen, um Dokumentation für diesen Quellcode zu generieren. Ich möchte jedoch nichts in diesem

c++ input documentation doxygen 2013-03-18

---