Coverage for gws-app/gws/lib/vendor/dog/options.py: 0%

1class Options: 

2 docRoots: list[str] = [] 

3 """Documentation root directories.""" 

4 

5 outputDir: str = '' 

6 """Output directory.""" 

7 

8 docPatterns: list[str] = ['*.doc.md'] 

9 """Shell patterns for documentation files.""" 

10 

11 assetPatterns: list[str] = ['*.svg', '*.png'] 

12 """Shell patterns for asset files.""" 

13 

14 excludeRegex: str = '' 

15 """Paths matching this regex will be excluded.""" 

16 

17 debug: bool = False 

18 """Debug/verbose mode.""" 

19 

20 fileSplitLevel: dict = {} 

21 """Split levels for output files.""" 

22 

23 pageTemplate: str = '' 

24 """Jump template for HTML pages.""" 

25 

26 webRoot: str = '' 

27 """Prefix for all URLs.""" 

28 

29 staticDir: str = '_static' 

30 """Web directory for static files.""" 

31 

32 extraAssets: list[str] = [] 

33 """Extra assets to be copied to the static dir.""" 

34 

35 includeTemplate: str = '' 

36 """Jump template to include in every section.""" 

37 

38 serverHost: str = '0.0.0.0' 

39 """Live server hostname.""" 

40 

41 serverPort: int = 5500 

42 """Live server port.""" 

43 

44 title: str = '' 

45 """Documentation title.""" 

46 

47 subTitle: str = '' 

48 """Documentation subtitle.""" 

49 

50 pdfPageTemplate: str = '' 

51 """Jump template for PDF.""" 

52 

53 pdfOptions: dict = {} 

54 """Options for wkhtmltopdf."""