documentation

18Ciepło

1Odpowiedz

Po wydaniu przez Node.js wersji 0..12 pliku official documentation nie można już przeglądać dokumentacji węzła v0.10. Czy istnieje dokumentacja node.js online dla wersji v0.10 (nie najnowszej)? Dzięku

20Ciepło

4Odpowiedz

Slate vs Swagger - Który jest lepszy i który ma więcej opcji?

Muszę udokumentować moje API. Muszę użyć jednego z nich Slate lub Swagger. Chcę wiedzieć, który z nich ma więcej opcji, zalet i wad, który jest lepszy.

6Ciepło

1Odpowiedz

Automatyczne dodawanie szkieletów dociętych do istniejącego kodu Railsowego

Chciałbym móc wstawiać szablonowe komentarze w stylu YARD do istniejącej aplikacji Rails. Obecnie ma kilka komentarzy. Chciałbym klasy nagłówków i nagłówków metod, które mają określone parametry (prze

8Ciepło

1Odpowiedz

Używanie programu dub do tworzenia dokumentacji

Jak używać programu dub do tworzenia plików DDocs z plików źródłowych? Wygląda na to, że nie ma domyślnego polecenia w dubie, i chciałbym móc zautomatyzować ten proces.

6Ciepło

2Odpowiedz

Jak mogę pobrać wszystkie pliki PDF biblioteki programistów Apple?

Chcę, aby wersje PDF całej dokumentacji Apple z powodów odniesienia. Nie chcę ręcznie przeglądać wszystkich ich stron dokumentacji, aby pobrać. Znalazłem wiele rozwiązań w sąsiedztwie tego, czego potr

6Ciepło

1Odpowiedz

Jak mogę uzyskać autosummary Sfinksa, aby wyświetlał dokumenty dla atrybutów instancji?

Wszystkie inne typy (klasy, właściwości, metody itp.) Działają dobrze, ale gdy autosummary dostaje się do atrybutów instancji, powoduje to błąd "WARNING: failed to import AClass.a". Dziwne jest to, że

10Ciepło

1Odpowiedz

Nierozwiązane odniesienie do montażu z zamkiem z piasku

Próbuję wygenerować dokumentację za pomocą budowniczego pliku pomocy z zamku z piasku. Podczas budowania projektu w zamku sandbar otrzymuję następujący błąd. MRefBuilder : error : Unresolved assembly

14Ciepło

4Odpowiedz

Tworzenie dokumentu html z kolekcji listonosza

Opracowałem całkiem rozbudowany interfejs API i mam go na Postmanie, który działa całkiem nieźle. Teraz muszę wygenerować dokument html, aby zachować jego wersję wewnątrz/docs wraz z moimi źródłami. C

6Ciepło

1Odpowiedz

Dokument doc i `define_method`

Czy istnieje sposób komentowania metod zdefiniowanych w define_method w YardDoc? Próbowałem to: %w(one two three).each do |type| # The #{type} way # @return [String] the #{type} way def

10Ciepło

1Odpowiedz

Jak powinienem dokumentować atrybuty klas i obiektów za pomocą stylu Numpy?

Czytałem przez Numpy's documentation standards, i nie wydaje się, aby wspomnieć o atrybutach obiektu - tylko atrybuty klasy. Na przykład, w jaki sposób mogę udokumentować następujące? class ClassA(obj