Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 858 Bytes

README.md

File metadata and controls

44 lines (27 loc) · 858 Bytes
Raw

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