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.Używanie programu dub do tworzenia dokumentacji
8
A
Odpowiedz
5
Dokumenty budowlane przez dub
są rzeczywiście określone za pomocą typu kompilacji.
Wypróbuj dub build --build=docs
lub dub build --build=ddox
.
Ten pierwszy tworzy "zwykły" ddocs, drugi używa dub do pobrania ddox w celu sformatowania dokumentów.
Zostało to pokazane w pomocy, jest po prostu dobrze ukryte. Zajrzyj do sekcji "kompilacja" pod numerem dub build -h
(możesz użyć dub <command> -h
, aby uzyskać szczegółową pomoc dotyczącą określonego polecenia).
Powiązane problemy
- 1. Używanie programu SyncAdapter bez tworzenia konta
- 2. Narzędzia do tworzenia dokumentacji dla API RPC
- 3. Używanie dokumentacji Javadocs do generowania dokumentu Swagger
- 4. Używanie programu IComparer do sortowania
- 5. Używanie przycisku Exit do zamykania programu WinForm
- 6. Zarządzanie zależnościami C o DUB
- 7. Umieszczanie obrazów w dokumentacji programu Haddock
- 8. Używanie rsync do tworzenia kopii zapasowych MySQL
- 9. Używanie MacRuby do tworzenia aplikacji na iPhone'a
- 10. Używanie Generics do tworzenia obiektu z interfejsem
- 11. Używanie JavaScript do "tworzenia" dokumentu Microsoft Word
- 12. Używanie iso do tworzenia VMware vmdk
- 13. Używanie ulotki do tworzenia mapy z obrazu
- 14. Używanie "by" do tworzenia wielu tytułów wykresów
- 15. Używanie PySide/PyQt do tworzenia aplikacji mobilnych
- 16. Używanie wpisów bazy danych do dynamicznego tworzenia diagramu wizualizacji
- 17. Używanie programu Paredit do zawijania istniejącego wyrażenia
- 18. Używanie programu MapMaker do utworzenia pamięci podręcznej
- 19. Javadoc do dokumentacji projektu
- 20. Używanie programu Rewire z TypeScript
- 21. VirtualBox: Używanie SDK API do uruchamiania programu u gościa?
- 22. Używanie argumentu wiersza polecenia do przekazywania plików do programu
- 23. Programowy dostęp do dokumentacji Java
- 24. Swift komentarz do standardowej dokumentacji
- 25. Korzystanie Appledocs do generowania dokumentacji
- 26. Błąd programu kwarcowego podczas tworzenia zadania
- 27. Python tworzenia słownika z danymi programu Excel
- 28. Używanie automatycznej dokumentacji mojej własnej funkcji z Qt Creator?
- 29. Używanie split (//, $ str, $ limit) zwracanie kończących pustych elementów, sprzecznych dokumentacji
- 30. Używanie Castle Windsor WcfFacility do tworzenia punktów końcowych klienta
Ponieważ moim kompilatorem jest GDC, jak się okazuje, nie działa to bez dodatkowych zmian w '' dub.json''. W szczególności, należy dodać następujące: "buildTypes": { "Docs": { "buildOptions": [ "syntaxOnly"] "dflags": [ "-c", "-fdoc", " -fdoc-dir =./docs "] } } –
Interesujące - możesz chcieć zgłosić to do dubu, ponieważ myślę, że powinno wygenerować odpowiednie flagi dla ciebie. – rcorre
Zrobię to. –