31d85c20db
Merge pull request #6202 from jbampton/clean-yardoc-folder
...
Remove the `.yardoc` folder with `rake doc:clean:api`
2024-03-13 09:08:07 +09:00
5895e8ebeb
Remove the .yardoc folder with rake doc:clean:api
2024-03-12 06:43:35 +10:00
d2206cd359
tasks/doc.rake: standardize the rake doc error messages
2024-03-12 05:30:54 +10:00
7082e95fa2
Fix word case: yard -> YARD
...
https://yardoc.org/
2023-04-04 18:20:52 +10:00
d318e992ea
Use rubygems.org links for yard-mruby and yard-coderay
...
The RubyGems website gives a much better overview of both Gems
A lot more quick links and statistics.
https://rubygems.org/gems/yard-mruby
https://rubygems.org/gems/yard-coderay
2022-12-30 12:39:54 +10:00
6da82230e8
Add more building documentation
2022-12-30 11:14:12 +10:00
e9b69c611d
rake doc: C API needs both Doxygen and Graphviz
...
https://www.doxygen.nl/
https://graphviz.org/download/
2022-12-30 10:08:15 +10:00
5e62990748
Add task rake doc:update-opcode.md
...
Allow to update `doc/internal/opcode.md` file mechanically from `include/mruby/ops.h` file.
At the same time, the `doc/internal/opcode.md` file has been updated.
Consecutive hyphens at the end of the table were removed as they would have created noise as markdown flavours.
2022-11-20 21:58:13 +09:00
1bf9ed196c
tasks: enable rake docs to open on macOS
...
The `xdg-open` command is not available on macOS.
macOS uses the `open` command.
Add info to install doxygen on macOS with Homebrew.
https://formulae.brew.sh/formula/doxygen
2022-10-26 15:39:10 +10:00
89ea8fa34a
Add instructions for installing doxygen on RHEL/Fedora/CentOS
2021-08-13 14:53:20 -04:00
0dfcaaed63
Use namespaces according to Rake conventions
...
Change the Rake task to one that uses namespaces as follows (previous task
names can also be used for compatibility).
| Previous Task | New Task |
|----------------|----------------|
| api_doc | doc:api |
| capi_doc | doc:capi |
| clean_doc | doc:clean |
| clean_api_doc | doc:clean:api |
| clean_capi_doc | doc:clean:capi |
| view_api | doc:view:api |
| view_capi | doc:view:capi |
| gitlab_config | gitlab:config |
| gitlab_dockers | gitlab:dockers |
2021-01-07 17:31:05 +09:00
26e6e75ba6
Use Rake DSL instead of commands of FileUtils
...
- Respect `--verbose(-v)` and `--dry-run(-n)` options.
- Silence warnings to keyword arguments on Ruby 2.7.
2019-12-27 16:49:32 +09:00
6375639917
fix lots of warnings and make logo not so big
2019-08-26 02:08:33 +09:00
e1e96c0cf4
change doc directory and reduce warnings
2019-08-26 00:23:28 +09:00
Yukihiro "Matz" Matsumoto