documentation

53Ciepło

6Odpowiedz

Jaki jest poprawny sposób udokumentowania parametru ** kwargs?

Używam sphinx i wtyczki autodoc do generowania dokumentacji API dla moich modułów Pythona. Chociaż mogę zobaczyć, jak dobrze udokumentować określone parametry, nie mogę znaleźć przykładu, jak udokumen

5Ciepło

4Odpowiedz

Jak wygenerować dokumentację, uruchamiając polecenie przy każdym zatwierdzeniu svn

Czy jest możliwe, aby svn uruchomił jakieś polecenie przed każdym zatwierdzeniem? Mam trochę dokumentacji w LaTeX w repozytorium i chciałbym mieć zawsze najnowszą wersję skompilowanych dokumentów dost

5Ciepło

8Odpowiedz

Czy istnieje odpowiednik MSDN dla systemów Mac OS i Linux?

Jestem zaznajomiony z kodowaniem w środowisku Windows. W przypadku niektórych naszych produktów użytkownicy ciągle proszą o przeniesienie na systemy Linux i Mac. Na początek potrzebuję zestawu dokumen

6Ciepło

2Odpowiedz

Kod źródłowy beautifier dla C++ (vC++)?

Mam zestaw 250 plików nagłówkowych i plików cpp w moim projekcie. Chciałem sformatować stary kod i wygenerować dokumentację interfejsu API. Czy jest jakieś narzędzie, które może mi w tym pomóc? Myślę

5Ciepło

3Odpowiedz

Jak utworzyć linki podobne do MSDN na stronie dokumentacji Sandcastle?

Wygenerowałem dokumentację internetową mojego projektu z Sandcastle. Ta strona używa ramek, więc gdy klikam strony, mój adres URL w przeglądarce się nie zmienia. Chciałbym zmienić adres URL w przegląd

48Ciepło

6Odpowiedz

Generator dokumentacji dla Objective-C?

Czy istnieje ogólnie przyjęty generator dokumentacji dla Objective-C (podobny do RDoc dla Ruby)? Widziałem Doxygen i ObjcDoc i zastanawiam się, które jest najczęściej używane.

7Ciepło

1Odpowiedz

Komunikaty o błędach GNU C++

Czy istnieje pełna lista komunikatów o błędach/ostrzeżeniach dla kompilatora g ++ dostępnego online? Szukam czegoś podobnego do dokumentacji MSDN, która opisuje, co oznacza każdy komunikat i ewentualn

14Ciepło

2Odpowiedz

Jak dokumentować kod Ruby za pomocą Doxygen?

Pytanie: Jak mogę dokumentować kod Ruby za pomocą Doxygen? Nota prawna: Wiem, że ruby ma już wbudowany system dokumentacji i prawdopodobnie istnieją inne sposoby, aby to zrobić, ale specyficznym ogr

6Ciepło

3Odpowiedz

Sfinks Templating

Używam sphinx. Chcę go szablonować. Więc po przeczytaniu docs, co usiłuję jest, moim conf.py, umieścić taką linię, templates_path = ['_templates'] i stworzyłem plik _templates/page.html Ale to rob

9Ciepło

2Odpowiedz

Rozszerzenie Python C: sygnatury metod dla dokumentacji?

Piszę rozszerzenia C i chciałbym, aby podpis moich metod był widoczny dla introspekcji. static PyObject* foo(PyObject *self, PyObject *args) { /* blabla [...] */ } PyDoc_STRVAR( foo_doc,