Add RDoc documentation site for Rubydex APIs#874
Conversation
6131fbc to
dda7daf
Compare
| * unqualified_name -> String? | ||
| * | ||
| * Returns the declaration name without namespace qualification. | ||
| */ |
There was a problem hiding this comment.
RDoc's C parser only recognizes this style of C comments.
| // Declaration#unqualified_name -> String | ||
| /* | ||
| * call-seq: | ||
| * unqualified_name -> String? |
There was a problem hiding this comment.
RDoc currently doesn't have a way to read RBS sigs from C files yet. So let's use call-seq for now.
dda7daf to
35891d3
Compare
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v5.0.0 |
There was a problem hiding this comment.
Doesn't GH pages deploy automatically if docs is modified? Maybe something changed, but I remembered the process being a bit simpler.
For example, the Ruby LSP GH pages website just builds everything in docs and pushes a commit to a specific branch.
There was a problem hiding this comment.
That's the branch-based deployment approach. I chose a different approach here as explained in #874 (comment)
| @@ -0,0 +1,5 @@ | |||
| README.md | |||
| CONTRIBUTING.md | |||
| docs/*.md | |||
There was a problem hiding this comment.
After this, we really ought to give some love to the architecture docs, which are really behind and lacking at the moment. I ended up never finishing #423
3b5eedf to
3e74247
Compare
3e74247 to
890b569
Compare
| #include "location.h" | ||
|
|
||
| /* | ||
| * RDoc parser workaround for https://github.com/ruby/rdoc/issues/1744: |
There was a problem hiding this comment.
It's not the best that we need to spread this in almost all of our C files. Is there already a solution in RDoc? If there is, let's create a ticket to get rid of these so we don't forget.
There was a problem hiding this comment.
I asked Codex to prototype a solution but I haven't looked into it yet.
2f7e79b to
98a2517
Compare
98a2517 to
010634e
Compare
Problems
Solutions
call-seq:blocks with RBS-ish return shapes.(The
workspace_pathattribute's type label is weird but it's a RDoc issue)