Giter Club home page Giter Club logo

docset_generator's Introduction

โ— Notice

This thing is INCOMPLETE!

The main idea here was to use

  • Agents/GenServer for running tasks, reporting errors, ...
  • Tasks for indexing the files' contents parallelly.
  • Streams for feeding back from the discovery of files in the tree automatically and putting it into a queue for scheduling the tasks.
  • VIA Tuple Registry for getting a hold of each individual process and make them able to adress each other.

After all of that, it would generate a SQLite database (probably with Ecto) and tie it into a Docset, in one big package.

DocsetGenerator

A scripting executable tool to convert ExDoc generated HTML documentation to the Dash format.

TODO

Chores

  • [] Fixtures for a sample generated ExDoc documentation.

Persistence

  • [] SQLite adapter setup.
  • [] Ecto schema to map entries to SQLite database tables.
  • [] Tests for generating a sample database.

Entry-matching

  • [] Tests for Regex-matching:
    • Types
    • Callbacks
    • Functions
    • Behaviours
    • Exceptions
    • Modules
    • Guides

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.