プロジェクト

全般

プロフィール

Vote #79711

未完了

Redmine reference with version info

Admin Redmine さんが約4年前に追加. 約4年前に更新.

ステータス:
New
優先度:
通常
担当者:
-
カテゴリ:
Documentation_24
対象バージョン:
-
開始日:
2022/05/09
期日:
進捗率:

0%

予定工数:
category_id:
24
version_id:
0
issue_org_id:
30230
author_id:
284508
assigned_to_id:
0
comments:
2
status_id:
1
tracker_id:
2
plus1:
0
affected_version:
closed_on:
affected_version_id:
ステータス-->[New]

説明

I was generated Redmine reference with version infomation. See below.

This was generated by only executing $ bundle exec rake yard. We can see codes "here":https://github.com/sho-h/redmine/tree/rich_reference_for_plugin .

Add new "yard template":https://github.com/sho-h/redmine/tree/rich_reference_for_plugin/doc/yardoc/templates/rich_reference

Add "redmine version info":https://github.com/sho-h/redmine/blob/rich_reference_for_plugin/doc/yardoc/redmine_changes.yml

git checkout

yard doc --no-output && mv .yardoc .yardoc. # generate only .yardoc

Repeat 1. and 2. with all tag

yard diff .yardoc. .yardoc.

Repeat 4. with all tag

Reform all 4. and 5. result to redmine_changes.yml

Fix yard "rake task":https://github.com/sho-h/redmine/commit/18c65ed66629f318836019446c76cc4ac4bb6ef1 to use a new template

I want to publish either of the following to maintenance redmine plugins easily.

  • redmine.github.io/redmine// # need to create gh-pages branch on Github mirror
  • yardoc.redmine.jp/Redmine// # need to talk with @g_maeda san?

journals

#28996 is related with this ticket.
--------------------------------------------------------------------------------
> We can see codes here.

Maybe, version info should be belongs to generator only to generate past version.
I will create redmine plugin to overwrite rake yard task(in lib/tasks/yardoc.rake) and maintain it if this suggestion will be accept.
--------------------------------------------------------------------------------

他の形式にエクスポート: Atom PDF

いいね!0
いいね!0