mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
df7dac9174
RDoc 4.1.0 contains a number of enhancements including a new default style and accessibility support. You can see the changelog here: https://github.com/rdoc/rdoc/blob/v4.1.0.preview.1/History.rdoc * test/rdoc: ditto. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@42971 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
63 lines
1.7 KiB
Text
63 lines
1.7 KiB
Text
<body role="document">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" class="nav-section">
|
|
<h2>
|
|
<a href="<%= rel_prefix %>/" rel="home">Home</a>
|
|
</h2>
|
|
</div>
|
|
|
|
<%= render '_sidebar_search.rhtml' %>
|
|
</div>
|
|
|
|
<%= render '_sidebar_installed.rhtml' %>
|
|
</nav>
|
|
|
|
<main role="main">
|
|
<h1>Local RDoc Documentation</h1>
|
|
|
|
<p>Here you can browse local documentation from the ruby standard library and
|
|
your installed gems.
|
|
|
|
<% extra_dirs = installed.select { |_, _, _, type,| type == :extra } %>
|
|
<% unless extra_dirs.empty? %>
|
|
<h2>Extra Documentation Directories</h2>
|
|
|
|
<p>The following additional documentation directories are available:</p>
|
|
|
|
<ol>
|
|
<% extra_dirs.each do |name, href, exists, _, path| %>
|
|
<li>
|
|
<% if exists %>
|
|
<a href="<%= href %>"><%= h name %></a> (<%= h path %>)
|
|
<% else %>
|
|
<%= h name %> (<%= h path %>; <i>not available</i>)
|
|
<% end %>
|
|
</li>
|
|
<% end %>
|
|
</ol>
|
|
<% end %>
|
|
|
|
<% gems = installed.select { |_, _, _, type,| type == :gem } %>
|
|
<% missing = gems.reject { |_, _, exists,| exists } %>
|
|
<% unless missing.empty? then %>
|
|
<h2>Missing Gem Documentation</h2>
|
|
|
|
<p>You are missing documentation for some of your installed gems.
|
|
You can install missing documentation for gems by running
|
|
<kbd>gem rdoc --all</kbd>. After installing the missing documentation you
|
|
only need to reload this page. The newly created documentation will
|
|
automatically appear.
|
|
|
|
<p>You can also install documentation for a specific gem by running one of
|
|
the following commands.
|
|
|
|
<ul>
|
|
<% names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq %>
|
|
<% names.each do |name| %>
|
|
<li><kbd>gem rdoc <%=h name %></kbd>
|
|
<% end %>
|
|
</ul>
|
|
<% end %>
|
|
</main>
|
|
|