Skip to main content
Ctrl+K

FORD 7.0.11 documentation

Contents:

  • User Guide
    • Getting Started
    • Writing Documentation
    • Running FORD
    • Limitations
    • Documentation Metadata
    • Static Pages
    • Project File Options
    • Command Line Options
  • Developers Guide
  • API
    • ford package
      • ford.external_project module
      • ford.fixed2free2 module
      • ford.fortran_project module
      • ford.graphs module
      • ford.intrinsics module
      • ford._markdown module
      • ford.md_admonition module
      • ford.md_environ module
      • ford.md_striped_table module
      • ford.output module
      • ford.pagetree module
      • ford.reader module
      • ford.settings module
      • ford.sourceform module
      • ford.tipue_search module
      • ford.utils module
      • ford.version module
  • Repository
  • Suggest edit
  • Open issue
  • .rst

ford.tipue_search module

Contents

  • Tipue Search
  • Tipue_Search_JSON_Generator
    • Tipue_Search_JSON_Generator.create_node()
    • Tipue_Search_JSON_Generator.print_output()

ford.tipue_search module#

Tipue Search#

Serializes generated HTML to JSON that can be used by jQuery plugin - Tipue Search.

Adapted from the Pelican plugin by Talha Mansoor getpelican/pelican-plugins

class ford.tipue_search.Tipue_Search_JSON_Generator(output_path, project_url)#

Bases: object

create_node(html, loc, meta)#
print_output()#

previous

ford.sourceform module

next

ford.utils module

Contents
  • Tipue Search
  • Tipue_Search_JSON_Generator
    • Tipue_Search_JSON_Generator.create_node()
    • Tipue_Search_JSON_Generator.print_output()

By Chris MacMackin, Peter Hill

© Copyright 2022, Chris MacMackin, FORD Contributors.