Project

yard-readme

0.0
No commit activity in last 3 years
No release in over 3 years
yard-readmemattruzicka/yard-readmeHomepageDocumentationSource CodeBug TrackerWiki
Generate your README using comments in your code
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
7,826
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.3.0
Total releases
5
First release
2021-07-25
Latest release
2021-08-08
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-08-03
Reverse Dependencies
1

 Dependencies

Development

readme_yard
~> 0.1

Runtime

yard
~> 0.9.26
 Project Readme

yard-readme

A YARD plugin used by readme_yard. It adds a @readme tag to YARD.

It also replaces the default docstring parser so that only @readme tags and not their text values are stripped from the generated documentation. I prefer this over the default YARD behavior for the @readme tag because it allows the comments in the source code to signal the README dependency without pushing the generated YARD documentation into a separate "readme" section.

That said, I welcome a PR that adds the default behavior as an option, as I think it could be preferable for some use cases. Ideally, I or someone would open a YARD PR to make leaving the tag text an option when registering a tag. Especially since this plugin's current behavior of replacing the YARD::DocstringParser could potentially conflict with other YARD plugins and is also more vulnerable to change.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mattruzicka/yard-readme.