Skip to content

picoruby/picoruby.github.io

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

No description, website, or topics provided.

Resources

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE-BSD-NAVGOCO.txt

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published