All issues

mruby/cがmodule機能を（限定的に）実装したのでドキュメントの仕組みもmoduleに対応しなきゃならない！

#19

· hasumikin opened

on Aug 28, 2024

ドキュメント内の静的コンテンツとして関連記事へのリンクとかコラムを新たに書くとかもやっていけたらよさそう

#16

· hasumikin opened

on Mar 10, 2024

この自動生成の仕組みに汎用性を持たせてgem化する。jekyll pluginでもよいかも。このためにはPicoRubyには（いまのところは）ないmoduleにも対応する必要がある。PicoRubyにもmodule機能が入るかもしれないので、やっておくとよさそうではある

#15

· hasumikin opened

on Mar 10, 2024

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

#14

· hasumikin opened

on Mar 10, 2024

GitHub Action：picoruby/picoruby（masterブランチ）へのプッシュ時にrbsファイルが変更されていたらpicoruby/picoruby.github.ioを自動で更新するようにしたい

#13

· hasumikin opened

on Mar 10, 2024

privateメソッドは現状ドキュメンテーションに含めていないが、privateセクションを設けて載せるようにしてもいいかもしれない。ただし`@ignore`が注釈されていたら載せない

#12

· hasumikin opened

on Mar 10, 2024

定数もドキュメント化したい

#11

· hasumikin opened

on Mar 10, 2024

いまは（画像参照）`member[:souce]`（`(Integer) -> 0`みたいな素のテキスト）を生成ドキュメントにそのまんま使用しているが、`member[:required_positionals]`以下の情報（現在は未使用）を組み合わせてドキュメントを生成するようにしたい。これができると、たとえば`Integer`という型名から`Integer.html`へリンクできるのではないかと思っている。type_aliasも同様にリンクしたい

#10

· hasumikin opened

on Mar 10, 2024

継承（superクラス）についての情報を載せたい

#9

· hasumikin opened

on Mar 10, 2024

あわせて、picoruby/mrbgems/picoruby-mrubyc/sig/*.rbs（つまりPicoRubyコアライブラリの型情報）の多くは、rbs gemがもっているCRubyコアの型ファイルをコピってきてsteep checkが通るだけの状態へ雑に編集しただけのもの。パクってきたときにいっしょについてきた元々のコメントには解説文（riで読めるやつ）がくっついているので、これの記法も整合性をとる必要あり

#8

· hasumikin opened

on Mar 10, 2024

rbsファイル内のclass定義やメソッド定義にマークダウン（？）でコメント（用例など）を書くと、それがドキュメントにも載るようにしたい。注意点としては、すでにコメント部分には機能があって、`@sidebar` `@added_by` `@ignore`という注釈がmd生成に影響を与えているので、そことの整合性を設計する必要あり

#7

· hasumikin opened

on Mar 10, 2024

tagsの機能がうまく動いていない（たとえば https://picoruby.github.io/tag_introduction.html が404）

#6

· hasumikin opened

on Mar 10, 2024