Module ImportFrom alias Import alias ImportFrom alias alias ImportFrom alias alias ClassDef bases NameLoad body FunctionDef arguments args NameParam defaults body Assign AttributeStore NameLoad attr ListLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign AttributeStore NameLoad attr ListLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str decorator_list decorator_list ClassDef bases NameLoad NameLoad body FunctionDef arguments args NameParam defaults vararg body Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad Assign AttributeStore NameLoad attr Dict decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Call AttributeLoad NameLoad attr NameLoad Return Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str If CompareIs NameLoad NameLoad body If CompareIsNot AttributeLoad NameLoad attr NameLoad body Assign NameStore AttributeLoad NameLoad attr orelse If UnaryOpNot AttributeLoad NameLoad attr body Return orelse If AttributeLoad NameLoad attr body Raise Call NameLoad Str Return Call AttributeLoad NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call NameLoad NameLoad AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad Str attr AttributeLoad NameLoad attr Call NameLoad NameLoad orelse If BoolOpAnd CompareIsNot AttributeLoad NameLoad attr NameLoad CompareNotEq Call NameLoad NameLoad AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad Str attr AttributeLoad NameLoad attr NameLoad AttributeLoad NameLoad attr Call NameLoad NameLoad orelse Return NameLoad Raise Call NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body If BoolOpOr CompareIs Call AttributeLoad NameLoad attr NameLoad NameLoad CompareIs AttributeLoad NameLoad attr NameLoad body Return Assign NameStore Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If CompareNotIn Str AttributeLoad NameLoad attr body Assign NameStore NameLoad Assign NameStore AttributeLoad NameLoad attr orelse Assign TupleStore NameStore NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Str Num Assign NameStore NameLoad For NameStore Call AttributeLoad NameLoad attr Str body Assign NameStore Call AttributeLoad NameLoad attr NameLoad Dict If UnaryOpNot Call NameLoad NameLoad NameLoad body Return Assign SubscriptStore NameLoad Index NameLoad Call AttributeLoad NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults Str NameLoad body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If CompareEq NameLoad Str body Return NameLoad TryExcept body Assign NameStore Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type TupleLoad NameLoad NameLoad body Raise Call NameLoad Str If AttributeLoad NameLoad attr body Return NameLoad Raise Call NameLoad Str decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body If BoolOpAnd CompareIsNot SubscriptLoad NameLoad Index Str NameLoad CompareIs Call AttributeLoad NameLoad attr Str NameLoad body Assign NameStore Call AttributeLoad AttributeLoad Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str attr attr If CompareEq NameLoad Str body Assign SubscriptStore NameLoad Index Str Str orelse If CompareEq NameLoad Str body Assign SubscriptStore NameLoad Index Str Str orelse Assign SubscriptStore NameLoad Index Str Call AttributeLoad SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num attr decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults NameLoad kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr keyword AttributeLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad If BoolOpAnd AttributeLoad NameLoad attr UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad Return Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body If Call AttributeLoad SubscriptLoad NameLoad Index Str attr SubscriptLoad NameLoad Index Str body Raise Call NameLoad Call AttributeLoad Str attr SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str orelse If Call AttributeLoad SubscriptLoad NameLoad Index Str attr SubscriptLoad NameLoad Index Str body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad Str attr SubscriptLoad NameLoad Index Str SubscriptLoad NameLoad Index Str decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults body Assign NameStore Call NameLoad ListComp CompareIn Str NameLoad comprehension NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Assign NameStore ListLoad SubscriptLoad Call AttributeLoad NameLoad attr Index SubscriptLoad NameLoad Index Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str If CompareIsNot SubscriptLoad NameLoad Index Str NameLoad body If UnaryOpNot NameLoad body Assign NameStore ListLoad Expr Call AttributeLoad NameLoad attr Num SubscriptLoad NameLoad Index Str Assign SubscriptStore NameLoad Index Str NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Str Expr Call AttributeLoad SubscriptLoad NameLoad Index Str attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore ListLoad Str Str Str Str Str Str Str Str Str Str Str Str Str If CompareIn NameLoad NameLoad body Return NameLoad orelse If CompareIn NameLoad NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad Raise Call NameLoad Call AttributeLoad Str attr NameLoad Call AttributeLoad Str attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults NameLoad kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If Call NameLoad NameLoad NameLoad body Return NameLoad orelse Raise Call NameLoad Call AttributeLoad Str attr Call NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If CompareIs AttributeLoad NameLoad attr NameLoad body Raise NameLoad For TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad body Expr Call AttributeLoad NameLoad attr For NameStore Call NameLoad NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Call AttributeLoad NameLoad attr NameLoad If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Continue Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If Call AttributeLoad NameLoad attr NameLoad body Expr Yield NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body If CompareIsNot SubscriptLoad NameLoad Index NameLoad NameLoad body Return Assign NameStore ListLoad For NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str body Expr Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call NameLoad NameLoad NameLoad body Raise Call NameLoad Call AttributeLoad Str attr Call NameLoad NameLoad If CompareEq Call NameLoad NameLoad Num body Return Assign NameStore Call NameLoad GeneratorExp Call NameLoad NameLoad comprehension NameStore NameLoad If Call AttributeLoad NameLoad attr Call NameLoad ListLoad AttributeLoad NameLoad attr NameLoad NameLoad body Return NameLoad If Call AttributeLoad NameLoad attr Call NameLoad ListLoad AttributeLoad NameLoad attr NameLoad NameLoad body Return Call AttributeLoad NameLoad attr NameLoad Raise Call NameLoad Call AttributeLoad Str attr NameLoad Call NameLoad ListLoad AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body If CompareIsNot SubscriptLoad NameLoad Index NameLoad NameLoad body Return Assign NameStore ListLoad For NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str body If CompareEq SubscriptLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Index Num Str body Expr Call AttributeLoad NameLoad attr Num NameLoad orelse Expr Call AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index NameLoad Call AttributeLoad NameLoad attr NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults Num kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body If CompareIsNot SubscriptLoad NameLoad Index NameLoad NameLoad body Return TryExcept body Assign SubscriptStore NameLoad Index NameLoad CompareGt Call NameLoad SubscriptLoad NameLoad Index Str AttributeLoad NameLoad attr handlers ExceptHandler type NameLoad body Assign SubscriptStore NameLoad Index NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Raise Call NameLoad Str decorator_list decorator_list ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad Str kwarg body Expr Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr BoolOpOr NameLoad ListLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Dict decorator_list FunctionDef arguments args NameParam NameParam defaults body If UnaryOpNot Call NameLoad NameLoad TupleLoad NameLoad NameLoad body Raise Call NameLoad Str Assign NameStore ListLoad For NameStore NameLoad body If Call NameLoad NameLoad NameLoad body If CompareGt Call NameLoad NameLoad Num body Raise Call NameLoad Str Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad If CompareIs NameLoad NameLoad body Continue If UnaryOpNot Call NameLoad NameLoad NameLoad body Raise Call NameLoad Call AttributeLoad Str attr NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad orelse If Call NameLoad NameLoad AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad orelse Raise Call NameLoad Str Return Call AttributeLoad NameLoad attr BinOpAdd AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Assign SubscriptStore NameLoad Index AttributeLoad NameLoad attr AttributeLoad NameLoad attr decorator_list decorator_list
N/A __future__ unicode_literals N/A os mkdocs utils legacy mkdocs.config.base Config ValidationError BaseConfigOption N/A object N/A __init__ N/A N/A self N/A N/A N/A N/A self warnings N/A N/A N/A self default None N/A is_required N/A N/A self N/A N/A N/A False N/A validate N/A N/A self value N/A N/A N/A N/A N/A self run_validation value N/A reset_warnings N/A N/A self N/A N/A N/A N/A self warnings N/A N/A pre_validation N/A N/A self config key_name N/A N/A N/A 
        After all options have passed validation, perform a post validation
        process to do any additional changes dependant on other config values.

        The post validation process method should be implemented by subclasses.
         N/A run_validation N/A N/A self value N/A N/A N/A 
        Perform validation for a value.

        The run_validation method should be implemented by subclasses.
         N/A value N/A post_validation N/A N/A self config key_name N/A N/A N/A 
        After all options have passed validation, perform a post validation
        process to do any additional changes dependant on other config values.

        The post validation process method should be implemented by subclasses.
         N/A N/A SubConfig N/A BaseConfigOption Config N/A __init__ N/A N/A self N/A config_options N/A N/A N/A N/A BaseConfigOption __init__ self N/A N/A N/A Config __init__ self config_options N/A N/A self default N/A N/A validate N/A N/A self value N/A N/A N/A N/A N/A self load_dict value N/A N/A N/A self run_validation value N/A run_validation N/A N/A self value N/A N/A N/A N/A N/A Config validate self N/A self N/A N/A OptionallyRequired N/A BaseConfigOption N/A N/A 
    The BaseConfigOption adds support for default values and required values

    It then delegates the validation and (optional) post validation processing
    to subclasses.
     __init__ N/A N/A self default required N/A None False N/A N/A N/A N/A N/A super OptionallyRequired self __init__ N/A N/A self default default N/A N/A self required required N/A is_required N/A N/A self N/A N/A N/A N/A self required N/A validate N/A N/A self value N/A N/A N/A 
        Perform some initial validation.

        If the option is empty (None) and isn't required, leave it as such. If
        it is empty but has a default, use that. Finally, call the
        run_validation method on the subclass unless.
         N/A N/A value None N/A N/A N/A N/A self default None N/A N/A value N/A self default N/A N/A N/A N/A self required N/A N/A N/A N/A N/A self required N/A N/A N/A ValidationError Required configuration not provided. N/A N/A N/A self run_validation value N/A N/A Type N/A OptionallyRequired N/A N/A 
    Type Config Option

    Validate the type of a config option against a given Python type.
     __init__ N/A N/A self type_ length N/A None kwargs N/A N/A N/A N/A N/A super Type self __init__ kwargs N/A N/A self _type type_ N/A N/A self length length N/A run_validation N/A N/A self value N/A N/A N/A N/A N/A isinstance value N/A self _type N/A N/A msg N/A N/A Expected type: {0} but recieved: {1} format N/A self _type N/A type value N/A N/A N/A N/A N/A self length None N/A N/A len value N/A self length N/A N/A msg N/A N/A Expected type: {0} with lenght {2} but recieved: {1} with length {3} format N/A self _type value N/A self length N/A len value N/A N/A value N/A N/A ValidationError msg N/A N/A Deprecated N/A BaseConfigOption N/A __init__ N/A N/A self moved_to N/A None N/A N/A N/A N/A N/A super Deprecated self __init__ N/A N/A self default None N/A N/A self moved_to moved_to N/A pre_validation N/A N/A self config key_name N/A N/A N/A N/A N/A N/A N/A config get key_name None N/A N/A self moved_to None N/A N/A N/A warning The configuration option {0} has been deprecated and will be removed in a future release of MkDocs. N/A N/A N/A N/A self warnings append warning N/A N/A . N/A self moved_to N/A N/A target config N/A target_key N/A self moved_to N/A N/A N/A move_to target_key N/A N/A N/A self moved_to rsplit . 1 N/A target config N/A key N/A N/A move_to split . N/A N/A target N/A N/A target setdefault key N/A N/A N/A N/A isinstance target dict N/A N/A N/A N/A target N/A target_key N/A N/A config pop key_name N/A N/A URL N/A OptionallyRequired N/A N/A 
    URL Config Option

    Validate a URL by requiring a scheme is present.
     __init__ N/A N/A self default required N/A False N/A N/A N/A N/A N/A super URL self __init__ default required N/A run_validation N/A N/A self value N/A N/A N/A N/A value N/A N/A value N/A N/A N/A parsed_url N/A N/A utils urlparse value N/A N/A N/A N/A AttributeError TypeError N/A N/A N/A ValidationError Unable to parse the URL. N/A N/A parsed_url scheme N/A N/A value N/A N/A ValidationError The URL isn't valid, it should include the http:// (scheme) N/A N/A RepoURL N/A URL N/A N/A 
    Repo URL Config Option

    A small extension to the URL config that sets the repo_name, based on the
    url if it hasn't already been provided.
     post_validation N/A N/A self config key_name N/A N/A N/A N/A N/A N/A config N/A repo_url None N/A N/A N/A config get repo_name None N/A N/A repo_host N/A N/A N/A N/A N/A utils urlparse N/A config N/A repo_url netloc lower N/A N/A repo_host github.com N/A N/A N/A config N/A repo_name GitHub N/A N/A N/A repo_host bitbucket.org N/A N/A N/A config N/A repo_name Bitbucket N/A N/A N/A config N/A repo_name N/A N/A N/A N/A N/A repo_host split . N/A 0 title N/A N/A Dir N/A Type N/A N/A 
    Dir Config Option

    Validate a path to a directory, optionally verifying that it exists.
     __init__ N/A N/A self exists N/A False kwargs N/A N/A N/A N/A N/A super Dir self __init__ type_ N/A utils string_types kwargs N/A N/A self exists exists N/A run_validation N/A N/A self value N/A N/A N/A value N/A N/A N/A super Dir self run_validation value N/A N/A N/A self exists N/A N/A N/A N/A os path isdir value N/A N/A N/A ValidationError N/A N/A The path {0} doesn't exist format value N/A N/A N/A N/A os path abspath value N/A N/A SiteDir N/A Dir N/A N/A 
    SiteDir Config Option

    Validates the site_dir and docs_dir directories do not contain each other.
     post_validation N/A N/A self config key_name N/A N/A N/A N/A N/A N/A config N/A docs_dir startswith N/A config N/A site_dir N/A N/A N/A ValidationError N/A N/A The 'docs_dir' should not be within the 'site_dir' as this can mean the source files are overwritten by the output or it will be deleted if --clean is passed to mkdocs build.(site_dir: '{0}', docs_dir: '{1}') format N/A config N/A site_dir N/A config N/A docs_dir N/A N/A N/A N/A N/A config N/A site_dir startswith N/A config N/A docs_dir N/A N/A N/A N/A N/A self warnings append N/A N/A The 'site_dir' should not be within the 'docs_dir' as this leads to the build directory being copied into itself and duplicate nested files in the 'site_dir'.(site_dir: '{0}', docs_dir: '{1}') format N/A config N/A site_dir N/A config N/A docs_dir N/A N/A ThemeDir N/A Dir N/A N/A 
    ThemeDir Config Option

    Post validation, verify the theme_dir and do some path munging.

    TODO: This could probably be improved and/or moved from here. It's a tad
    gross really.
     post_validation N/A N/A self config key_name N/A N/A N/A theme_in_config N/A any N/A N/A theme c N/A c N/A config user_configs N/A package_dir N/A N/A N/A os path abspath N/A N/A N/A os path join N/A N/A N/A os path dirname __file__ .. N/A theme_dir N/A N/A N/A N/A utils get_themes N/A N/A config N/A theme N/A N/A config N/A mkdocs_templates N/A N/A N/A os path join package_dir templates N/A N/A N/A config N/A theme_dir None N/A N/A N/A theme_in_config N/A N/A theme_dir N/A N/A N/A N/A theme_dir insert 0 N/A config N/A theme_dir N/A N/A config N/A theme_dir theme_dir N/A search_assets N/A N/A N/A os path join package_dir assets search N/A N/A N/A N/A config N/A theme_dir append search_assets N/A N/A Theme N/A OptionallyRequired N/A N/A 
    Theme Config Option

    Validate that the theme is one of the builtin Mkdocs theme names.
     run_validation N/A N/A self value N/A N/A N/A themes N/A N/A utils get_theme_names N/A moved_themes N/A bootstrap amelia cerulean cosmo cyborg flatly journal readable simplex slate spacelab united yeti N/A N/A value themes N/A N/A value N/A N/A N/A value moved_themes N/A N/A N/A ValidationError N/A N/A The theme '{0}' is no longer included in MkDocs by default and must be installed with pip. See http://www.mkdocs.org/about/release-notes/#add-support-for-installable-themesfor more details format value N/A N/A ValidationError N/A N/A Unrecognised theme '{0}'. The available installed themes are: {1} format value N/A N/A ,  join themes N/A N/A Extras N/A OptionallyRequired N/A N/A 
    Extras Config Option

    Validate the extra configs are a list and populate them with a set of files
    if not provided.
     __init__ N/A N/A self file_match N/A None kwargs N/A N/A N/A N/A N/A super Extras self __init__ kwargs N/A N/A self file_match file_match N/A run_validation N/A N/A self value N/A N/A N/A N/A isinstance value list N/A N/A value N/A N/A N/A ValidationError N/A N/A Expected a list, got {0} format N/A type value N/A walk_docs_dir N/A N/A self docs_dir N/A N/A N/A N/A N/A self file_match None N/A N/A StopIteration N/A N/A dirpath dirs filenames N/A N/A os walk docs_dir N/A N/A N/A N/A dirs sort N/A filename N/A sorted filenames N/A N/A fullpath N/A N/A N/A os path join dirpath filename N/A N/A N/A N/A os path islink fullpath N/A N/A fp N/A N/A N/A os path join dirpath N/A N/A os readlink fullpath N/A N/A N/A N/A N/A os path exists fp N/A N/A N/A relpath N/A N/A N/A os path normpath N/A N/A N/A os path relpath fullpath docs_dir N/A N/A N/A self file_match relpath N/A N/A N/A relpath N/A post_validation N/A N/A self config key_name N/A N/A N/A N/A N/A config N/A key_name None N/A N/A N/A extras N/A N/A filename N/A N/A self walk_docs_dir N/A config N/A docs_dir N/A N/A N/A N/A extras append filename N/A N/A config N/A key_name extras N/A N/A Pages N/A Extras N/A N/A 
    Pages Config Option

    Validate the pages config, performing comparability if the config appears
    to be the old structure. Automatically add all markdown files if none are
    provided.
     __init__ N/A N/A self N/A kwargs N/A N/A N/A N/A N/A super Pages self __init__ N/A utils is_markdown_file kwargs N/A run_validation N/A N/A self value N/A N/A N/A N/A N/A isinstance value list N/A N/A N/A ValidationError N/A N/A Expected a list, got {0} format N/A type value N/A N/A N/A len value 0 N/A N/A N/A config_types N/A set N/A N/A type l N/A l value N/A N/A N/A config_types issubset N/A set N/A N/A utils text_type dict str N/A N/A value N/A N/A N/A config_types issubset N/A set N/A N/A utils text_type list str N/A N/A N/A N/A legacy pages_compat_shim value N/A N/A ValidationError N/A N/A Invalid pages config. {0} {1} format config_types N/A set N/A N/A utils text_type dict N/A post_validation N/A N/A self config key_name N/A N/A N/A N/A N/A config N/A key_name None N/A N/A N/A pages N/A N/A filename N/A N/A self walk_docs_dir N/A config N/A docs_dir N/A N/A N/A N/A N/A N/A N/A os path splitext filename N/A 0 index N/A N/A N/A N/A pages insert 0 filename N/A N/A N/A N/A pages append filename N/A N/A config N/A key_name N/A N/A utils nest_paths pages N/A N/A NumPages N/A OptionallyRequired N/A N/A 
    NumPages Config Option

    Set the value to True if the number of pages is greater than the given
    number (defaults to 1).
     __init__ N/A N/A self at_lest N/A 1 kwargs N/A N/A N/A N/A N/A super NumPages self __init__ kwargs N/A N/A self at_lest at_lest N/A post_validation N/A N/A self config key_name N/A N/A N/A N/A N/A config N/A key_name None N/A N/A N/A N/A N/A N/A config N/A key_name N/A N/A len N/A config N/A pages N/A self at_lest N/A N/A N/A TypeError N/A N/A N/A config N/A key_name False N/A N/A Private N/A OptionallyRequired N/A N/A 
    Private Config Option

    A config option only for internal use. Raises an error if set by the user.
     run_validation N/A N/A self value N/A N/A N/A N/A ValidationError For internal use only. N/A N/A MarkdownExtensions N/A OptionallyRequired N/A N/A 
    Markdown Extensions Config Option

    A list of extensions. If a list item contains extension configs,
    those are set on the private  setting passed to `configkey`. The
    `builtins` keyword accepts a list of extensions which cannot be
    overriden by the user. However, builtins can be duplicated to define
    config options for them if desired.
     __init__ N/A N/A self builtins configkey N/A None mdx_configs kwargs N/A N/A N/A N/A N/A super MarkdownExtensions self __init__ kwargs N/A N/A self builtins N/A builtins N/A N/A N/A self configkey configkey N/A N/A self configdata N/A N/A run_validation N/A N/A self value N/A N/A N/A N/A N/A isinstance value N/A list tuple N/A N/A N/A ValidationError Invalid Markdown Extensions configuration N/A extensions N/A N/A item value N/A N/A N/A isinstance item dict N/A N/A N/A N/A len item 1 N/A N/A N/A ValidationError Invalid Markdown Extensions configuration N/A N/A ext cfg N/A N/A item popitem N/A N/A N/A extensions append ext N/A N/A cfg None N/A N/A N/A N/A N/A isinstance cfg dict N/A N/A N/A ValidationError N/A N/A Invalid config options for Markdown Extension '{0}'. format ext N/A N/A N/A self configdata N/A ext cfg N/A N/A N/A isinstance item N/A utils string_types N/A N/A N/A N/A extensions append item N/A N/A N/A ValidationError Invalid Markdown Extensions configuration N/A N/A N/A utils reduce_list N/A N/A self builtins extensions N/A post_validation N/A N/A self config key_name N/A N/A N/A N/A config N/A N/A self configkey N/A self configdata N/A N/A