Code Monkey home page Code Monkey logo

picoruby.github.io's Introduction

picoruby.github.io

Web site

https://picoruby.github.io/

First time setup

bundle install
bundle exec rake setup

Generating document process

  1. bundle exec rake s starts jelyll local server (Open Then open http://localhost:4000)
  2. Edit picoruby/mrbgems/picoruby-*/sig/*.rbs
  3. bundle exec rake
  4. lib/rbc_doc.rb is loaded
  5. RBSDoc::Generator instance collects RBS info
  6. Markdown files are generated in pages/rbs_doc/
  7. Jekyll process automatically generates html

Files to be patched

Generator

lib/rbs_doc/**/*

RBSs

Generally in picoruby/mrbgems/picoruby-*/sig/*.rbs

Annotation

(We need to detail more)

  • Sidebar: @sidebar [builtin|io_peripheral|prk_firmware|hardware_device]
  • Extension: @added_by [gem name]

HTML layouts and partials

_layouts/*.html and _includes/*.html

picoruby.github.io's People

Contributors

hasumikin avatar maimux2x avatar ydah avatar

Stargazers

 avatar  avatar Daniel Vinciguerra avatar

Forkers

maimux2x ydah

picoruby.github.io's Issues

RBSにはオプショナル引数のデフォルト値の情報が含まれない。たとえばrbファイルでは`def m(a=0)`となっている場合に、rgsでは`def m: (?Integer a)`となっていて、aのデフォルト値が0であることがわからない。デフォルト値をドキュメント化したいので、いいやり方がないか考えたい(コメントに書くとかでもいい思うが、rb実装との二重管理になってしまうから、rb実装ファイルから自動的に持ってこられるとありがたい)

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.