src/litterate/defaults.py annotated source

Back to index 

        

        
Default Configuration


This module contains the default configuration if the user doesn't specify
a value for any options.
5


6DEFAULTS = {


Project metadata: Name and description shown on the index page
8    "name": "My Project",


9    "description": (


10        "Replace this description by setting the `description` option on "


11        "`litterate`, or leave it blank"


12    ),


13


Line wrapping: If 0, long lines of source code will never be wrapped
15    "wrap": 0,


16


Base URL: By default, use relative paths for local file viewing.
Set to "/" for web root, or "/project-name" for GitHub Pages.
19    "baseURL": "./",


20


Verbose output: Control logging verbosity
22    "verbose": False,


23


Files to process: It's reasonable to assume that most projects keep
the main source files in ./src/, so that's the default files option.
26    "files": [


27        "./src/**/*.py",


28    ],


29


Output directory: We default to ./docs/ because this is where GitHub Pages pulls from.
31    "output_directory": "./docs/",


32


Annotation markers: These identify literate comments in the source code.
By default, use Python-style comments (#> to start, # to continue).
35    "annotation_start_mark": "#>",


36    "annotation_continue_mark": "#",


37


Syntax highlighting: Set to "auto" for automatic detection from file extension,
or specify a language like "python", "javascript", "java", etc.
40    "language": "auto",


41}


42