1. nikola

• 1.1. nikola package
  • 1.1.1. Subpackages
    • 1.1.1.1. nikola.packages package
      • 1.1.1.1.1. Subpackages
    • 1.1.1.2. nikola.plugins package
      • 1.1.1.2.1. Subpackages
      • 1.1.1.2.2. Submodules
      • 1.1.1.2.3. nikola.plugins.basic_import module
  • 1.1.2. Submodules
  • 1.1.3. nikola.filters module
    • add_header_permalinks()
    • apply_to_binary_file()
    • apply_to_text_file()
    • closure_compiler()
    • cssminify()
    • deduplicate_ids()
    • html5lib_minify()
    • html5lib_xmllike()
    • html_tidy_mini()
    • html_tidy_nowrap()
    • html_tidy_withconfig()
    • html_tidy_wrap()
    • html_tidy_wrap_attr()
    • jpegoptim()
    • jpegoptim_progressive()
    • jsminify()
    • jsonminify()
    • list_replace()
    • minify_lines()
    • normalize_html()
    • optipng()
    • php_template_injection()
    • runinplace()
    • typogrify()
    • typogrify_custom()
    • typogrify_oldschool()
    • typogrify_sans_widont()
    • xmlminify()
    • yui_compressor()
  • 1.1.4. nikola.hierarchy_utils module
    • TreeNode
      • TreeNode.get_children()
      • TreeNode.get_path()
      • TreeNode.indent_change_after
      • TreeNode.indent_change_before
      • TreeNode.indent_levels
    • clone_treenode()
    • flatten_tree_structure()
    • join_hierarchical_category_path()
    • parse_escaped_hierarchical_category_name()
    • sort_classifications()
  • 1.1.5. nikola.image_processing module
    • ImageProcessor
      • ImageProcessor.dates
      • ImageProcessor.filter_exif()
      • ImageProcessor.image_date()
      • ImageProcessor.image_ext_list_builtin
      • ImageProcessor.logger
      • ImageProcessor.resize_image()
      • ImageProcessor.resize_svg()
  • 1.1.6. nikola.log module
    • get_logger()
  • 1.1.7. nikola.metadata_extractors module
    • MetaCondition
      • MetaCondition.compiler
      • MetaCondition.config_bool
      • MetaCondition.config_present
      • MetaCondition.extension
      • MetaCondition.first_line
      • MetaCondition.never
    • MetaPriority
      • MetaPriority.fallback
      • MetaPriority.normal
      • MetaPriority.override
      • MetaPriority.specialized
    • MetaSource
      • MetaSource.filename
      • MetaSource.text
    • check_conditions()
  • 1.1.8. nikola.nikola module
    • Nikola
      • Nikola.GLOBAL_CONTEXT
      • Nikola.MESSAGES
      • Nikola.THEMES
      • Nikola.abs_link()
      • Nikola.apply_shortcodes()
      • Nikola.apply_shortcodes_uuid()
      • Nikola.atom_feed_renderer()
      • Nikola.category_path_to_category_name()
      • Nikola.clean_task_paths()
      • Nikola.file_exists()
      • Nikola.filename_path()
      • Nikola.gen_tasks()
      • Nikola.generic_atom_renderer()
      • Nikola.generic_index_renderer()
      • Nikola.generic_page_renderer()
      • Nikola.generic_post_list_renderer()
      • Nikola.generic_renderer()
      • Nikola.generic_rss_feed()
      • Nikola.generic_rss_renderer()
      • Nikola.get_compiler()
      • Nikola.init_plugins()
      • Nikola.link()
      • Nikola.parse_category_name()
      • Nikola.path()
      • Nikola.plugin_manager
      • Nikola.post_path()
      • Nikola.register_filter()
      • Nikola.register_path_handler()
      • Nikola.register_shortcode()
      • Nikola.rel_link()
      • Nikola.render_template()
      • Nikola.rewrite_links()
      • Nikola.root_path()
      • Nikola.scan_posts()
      • Nikola.slug_path()
      • Nikola.slug_source()
      • Nikola.sort_posts_chronologically()
      • Nikola.template_system
      • Nikola.url_replacer()
  • 1.1.9. nikola.plugin_categories module
    • Command
      • Command.cmd_options
      • Command.doc_description
      • Command.doc_purpose
      • Command.doc_usage
      • Command.execute()
      • Command.name
      • Command.needs_config
    • ConfigPlugin
      • ConfigPlugin.name
    • LateTask
      • LateTask.name
    • MarkdownExtension
      • MarkdownExtension.compiler_name
      • MarkdownExtension.name
    • MetadataExtractor
      • MetadataExtractor.check_requirements()
      • MetadataExtractor.conditions
      • MetadataExtractor.extract_filename()
      • MetadataExtractor.extract_text()
      • MetadataExtractor.map_from
      • MetadataExtractor.name
      • MetadataExtractor.priority
      • MetadataExtractor.requirements
      • MetadataExtractor.source
      • MetadataExtractor.split_metadata_from_text()
      • MetadataExtractor.split_metadata_re
      • MetadataExtractor.supports_write
      • MetadataExtractor.write_metadata()
    • PageCompiler
      • PageCompiler.compile()
      • PageCompiler.compile_string()
      • PageCompiler.config_dependencies
      • PageCompiler.create_post()
      • PageCompiler.default_metadata
      • PageCompiler.demote_headers
      • PageCompiler.extension()
      • PageCompiler.friendly_name
      • PageCompiler.get_compiler_extensions()
      • PageCompiler.get_dep_filename()
      • PageCompiler.get_extra_targets()
      • PageCompiler.metadata_conditions
      • PageCompiler.name
      • PageCompiler.read_metadata()
      • PageCompiler.register_extra_dependencies()
      • PageCompiler.split_metadata()
      • PageCompiler.supports_metadata
      • PageCompiler.supports_onefile
      • PageCompiler.use_dep_file
    • PostScanner
      • PostScanner.scan()
      • PostScanner.supported_extensions()
    • RestExtension
      • RestExtension.compiler_name
      • RestExtension.name
    • SignalHandler
      • SignalHandler.name
    • Task
      • Task.name
    • TaskMultiplier
      • TaskMultiplier.name
      • TaskMultiplier.process()
    • Taxonomy
      • Taxonomy.add_other_languages_variable
      • Taxonomy.always_disable_atom
      • Taxonomy.always_disable_rss
      • Taxonomy.apply_to_pages
      • Taxonomy.apply_to_posts
      • Taxonomy.classification_name
      • Taxonomy.classify()
      • Taxonomy.extract_hierarchy()
      • Taxonomy.get_classification_friendly_name()
      • Taxonomy.get_implicit_classifications()
      • Taxonomy.get_other_language_variants()
      • Taxonomy.get_overview_path()
      • Taxonomy.get_path()
      • Taxonomy.has_hierarchy
      • Taxonomy.include_posts_from_subhierarchies
      • Taxonomy.include_posts_into_hierarchy_root
      • Taxonomy.is_enabled()
      • Taxonomy.minimum_post_count_per_classification_in_overview
      • Taxonomy.more_than_one_classifications_per_post
      • Taxonomy.name
      • Taxonomy.omit_empty_classifications
      • Taxonomy.overview_page_hierarchy_variable_name
      • Taxonomy.overview_page_items_variable_name
      • Taxonomy.overview_page_variable_name
      • Taxonomy.path_handler_docstrings
      • Taxonomy.postprocess_posts_per_classification()
      • Taxonomy.provide_context_and_uptodate()
      • Taxonomy.provide_overview_context_and_uptodate()
      • Taxonomy.recombine_classification_from_hierarchy()
      • Taxonomy.should_generate_atom_for_classification_page()
      • Taxonomy.should_generate_classification_page()
      • Taxonomy.should_generate_rss_for_classification_page()
      • Taxonomy.show_list_as_index
      • Taxonomy.show_list_as_subcategories_list
      • Taxonomy.sort_classifications()
      • Taxonomy.sort_posts()
      • Taxonomy.subcategories_list_template
      • Taxonomy.template_for_classification_overview
      • Taxonomy.template_for_single_list
    • TemplateSystem
      • TemplateSystem.get_deps()
      • TemplateSystem.get_string_deps()
      • TemplateSystem.get_template_path()
      • TemplateSystem.inject_directory()
      • TemplateSystem.name
      • TemplateSystem.render_template()
      • TemplateSystem.render_template_to_string()
      • TemplateSystem.set_directories()
      • TemplateSystem.set_user_engine_factory()
      • TemplateSystem.template_deps()
  • 1.1.10. nikola.post module
    • Post
      • Post.add_dependency()
      • Post.add_dependency_uptodate()
      • Post.alltags
      • Post.author()
      • Post.authors()
      • Post.compile()
      • Post.deps()
      • Post.deps_uptodate()
      • Post.description()
      • Post.destination_path()
      • Post.formatted_date()
      • Post.formatted_updated()
      • Post.fragment_deps()
      • Post.fragment_deps_uptodate()
      • Post.guid()
      • Post.has_math
      • Post.has_oldstyle_metadata_tags
      • Post.has_pretty_url()
      • Post.hyphenate
      • Post.is_draft
      • Post.is_private
      • Post.is_translation_available()
      • Post.is_two_file
      • Post.next_post
      • Post.paragraph_count
      • Post.permalink()
      • Post.post_status
      • Post.prev_post
      • Post.previewimage
      • Post.reading_time
      • Post.register_depfile()
      • Post.remaining_paragraph_count
      • Post.remaining_reading_time
      • Post.save()
      • Post.should_hide_title()
      • Post.should_show_title()
      • Post.source()
      • Post.source_ext()
      • Post.source_link()
      • Post.tags
      • Post.tags_for_language()
      • Post.template_name
      • Post.text()
      • Post.title()
      • Post.translated_base_path()
      • Post.translated_source_path()
      • Post.write_depfile()
      • Post.write_metadata()
  • 1.1.11. nikola.shortcodes module
    • ParsingError
    • apply_shortcodes()
    • extract_shortcodes()
  • 1.1.12. nikola.state module
    • Persistor
      • Persistor.delete()
      • Persistor.get()
      • Persistor.set()
  • 1.1.13. nikola.utils module
    • CustomEncoder
      • CustomEncoder.default()
    • Functionary
    • LocaleBorg
      • LocaleBorg.current_lang
      • LocaleBorg.datetime_formatter
      • LocaleBorg.format_date_in_string()
      • LocaleBorg.formatted_date()
      • LocaleBorg.in_string_formatter
      • LocaleBorg.initialize()
      • LocaleBorg.initialized
      • LocaleBorg.reset()
      • LocaleBorg.set_locale()
    • NikolaPygmentsHTML
      • NikolaPygmentsHTML.wrap()
    • TemplateHookRegistry
      • TemplateHookRegistry.append()
      • TemplateHookRegistry.calculate_deps()
      • TemplateHookRegistry.generate()
    • TranslatableSetting
      • TranslatableSetting.default_lang
      • TranslatableSetting.format()
      • TranslatableSetting.get_lang()
      • TranslatableSetting.lang
      • TranslatableSetting.langformat()
    • TreeNode
      • TreeNode.get_children()
      • TreeNode.get_path()
      • TreeNode.indent_change_after
      • TreeNode.indent_change_before
      • TreeNode.indent_levels
    • adjust_name_for_index_link()
    • adjust_name_for_index_path()
    • adjust_name_for_index_path_list()
    • apply_filters()
    • ask()
    • ask_yesno()
    • bool_from_meta()
    • clean_before_deployment()
    • clone_treenode()
    • config_changed
      • config_changed.configure_task()
    • copy_file()
    • copy_tree()
    • create_redirect()
    • demote_headers()
    • flatten_tree_structure()
    • get_asset_path()
    • get_crumbs()
    • get_displayed_page_number()
    • get_parent_theme_name()
    • get_theme_chain()
    • get_theme_path()
    • get_theme_path_real()
    • get_translation_candidate()
    • get_tzname()
    • html_unescape()
    • indent()
    • join_hierarchical_category_path()
    • load_data()
    • load_messages()
    • makedirs()
    • map_metadata()
    • options2docstring()
    • os_path_split()
    • parse_escaped_hierarchical_category_name()
    • req_missing()
    • rss_writer()
    • slugify()
    • smartjoin()
    • sort_classifications()
    • sort_posts()
    • sys_decode()
    • sys_encode()
    • to_datetime()
    • unslugify()
    • write_metadata()
  • 1.1.14. nikola.winutils module
    • fix_all_git_symlinked()
    • is_file_in_dir()