Skip to content

Commit 394d587

Browse files
1 parent ab4ffdc commit 394d587

15 files changed

+173
-38
lines changed

apt.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,8 @@ <h2 id="nightly-releases">Nightly Releases</h2>
242242

243243
<p>To install a nightly apt package, download the archive and install it directly:</p>
244244

245-
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>wget https://drake-packages.csail.mit.edu/drake/nightly/drake-dev_latest-1_amd64-jammy.deb
246-
<span class="nb">sudo </span>apt-get <span class="nb">install</span> <span class="nt">--no-install-recommends</span> ./drake-dev_latest-1_amd64-jammy.deb
245+
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>wget https://drake-packages.csail.mit.edu/drake/nightly/drake-dev_latest-1_amd64-noble.deb
246+
<span class="nb">sudo </span>apt-get <span class="nb">install</span> <span class="nt">--no-install-recommends</span> ./drake-dev_latest-1_amd64-noble.deb
247247
</code></pre></div></div>
248248

249249
</article>

docker.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ <h2 id="stable-releases">Stable Releases</h2>
196196
<ul>
197197
<li><code class="language-plaintext highlighter-rouge">jammy-X.Y.Z</code> for the Ubuntu 22.04 image of Drake vX.Y.Z.</li>
198198
<li><code class="language-plaintext highlighter-rouge">noble-X.Y.Z</code> for the Ubuntu 24.04 image of Drake vX.Y.Z.</li>
199-
<li><code class="language-plaintext highlighter-rouge">X.Y.Z</code> is a synonym for <code class="language-plaintext highlighter-rouge">jammy-X.Y.Z</code>.</li>
199+
<li><code class="language-plaintext highlighter-rouge">X.Y.Z</code> is a synonym for <code class="language-plaintext highlighter-rouge">noble-X.Y.Z</code>.</li>
200200
</ul>
201201

202202
<p>Refer to <a href="/installation.html#quickstart">Quickstart</a> for next steps.</p>
@@ -217,7 +217,7 @@ <h2 id="nightly-releases">Nightly Releases</h2>
217217
<li><code class="language-plaintext highlighter-rouge">jammy</code> is a synonym for the most recent <code class="language-plaintext highlighter-rouge">jammy-YYYYMMDD</code>.</li>
218218
<li><code class="language-plaintext highlighter-rouge">noble-YYYYMMDD</code> for the Ubuntu 24.04 image of Drake as of date YYYY-MM-DD.</li>
219219
<li><code class="language-plaintext highlighter-rouge">noble</code> is a synonym for the most recent <code class="language-plaintext highlighter-rouge">noble-YYYYMMDD</code>.</li>
220-
<li><code class="language-plaintext highlighter-rouge">YYYYMMDD</code> is a synonym for the most recent <code class="language-plaintext highlighter-rouge">jammy-YYYYMMDD</code>.</li>
220+
<li><code class="language-plaintext highlighter-rouge">YYYYMMDD</code> is a synonym for the most recent <code class="language-plaintext highlighter-rouge">noble-YYYYMMDD</code>.</li>
221221
<li><code class="language-plaintext highlighter-rouge">latest</code> is a synonym for the most recent <code class="language-plaintext highlighter-rouge">YYYYMMDD</code>.</li>
222222
</ul>
223223

documentation_instructions.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h1>Documentation Generation Instructions</h1>
169169
<h1 id="prerequisites">Prerequisites</h1>
170170

171171
<p>Documentation generation and preview as described in this document are
172-
supported on Ubuntu <strong>22.04</strong> only.</p>
172+
supported on Ubuntu 22.04 (Jammy) and 24.04 (Noble).</p>
173173

174174
<p>Before getting started, install Drake’s prerequisites with the additional
175175
<code class="language-plaintext highlighter-rouge">--with-doc-only</code> command line option, i.e.:</p>
@@ -230,7 +230,7 @@ <h1 id="testing-in-ci">Testing in CI</h1>
230230
<a href="/jenkins.html#scheduling-an-on-demand-build">schedule an on-demand build</a>
231231
by posting a comment</p>
232232

233-
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>@drake-jenkins-bot linux-jammy-unprovisioned-gcc-bazel-experimental-documentation please
233+
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>@drake-jenkins-bot linux-noble-unprovisioned-gcc-bazel-experimental-documentation please
234234
</code></pre></div></div>
235235

236236
<h1 id="advanced-building">Advanced Building</h1>

doxygen_cxx/group__python__bindings.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ <h3>Bazel</h3>
275275
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;drake/bindings/pydrake/documentation_pybind.h&quot;</span></div><div class="line"></div><div class="line">PYBIND11_MODULE(math, m) {</div><div class="line"> <span class="keyword">using namespace </span><a class="code" href="namespacedrake_1_1math.html">drake::math</a>;</div><div class="line"> constexpr <span class="keyword">auto</span>&amp; doc = pydrake_doc.drake.math;</div><div class="line"> <span class="keyword">using</span> T = double;</div><div class="line"> py::class_&lt;RigidTransform&lt;T&gt;&gt;(m, <span class="stringliteral">&quot;RigidTransform&quot;</span>, doc.RigidTransform.doc)</div><div class="line"> .def(py::init(), doc.RigidTransform.ctor.doc_0args)</div><div class="line"> ...</div><div class="line"> .def(py::init&lt;<span class="keyword">const</span> <a class="code" href="classdrake_1_1math_1_1_rotation_matrix.html">RotationMatrix&lt;T&gt;</a>&amp;&gt;(), py::arg(<span class="stringliteral">&quot;R&quot;</span>),</div><div class="line"> doc.RigidTransform.ctor.doc_1args_R)</div><div class="line"> .def(py::init&lt;<span class="keyword">const</span> Eigen::Quaternion&lt;T&gt;&amp;, <span class="keyword">const</span> Vector3&lt;T&gt;&amp;&gt;(),</div><div class="line"> py::arg(<span class="stringliteral">&quot;quaternion&quot;</span>), py::arg(<span class="stringliteral">&quot;p&quot;</span>),</div><div class="line"> doc.RigidTransform.ctor.doc_2args_quaternion_p)</div><div class="line"> ...</div><div class="line"> .def(<span class="stringliteral">&quot;set_rotation&quot;</span>, &amp;<a class="code" href="classdrake_1_1math_1_1_rigid_transform.html">RigidTransform&lt;T&gt;::set_rotation</a>, py::arg(<span class="stringliteral">&quot;R&quot;</span>),</div><div class="line"> doc.<a class="code" href="classdrake_1_1math_1_1_rigid_transform.html#a8bedd8c483aaf5bc48587d10d7a3d485">RigidTransform</a>.set_rotation.doc)</div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --><p>An example of supplying custom strings:</p>
276276
<div class="fragment"><div class="line">constexpr <span class="keywordtype">char</span> another_helper_doc[] = R<span class="stringliteral">&quot;&quot;&quot;(</span></div><div class="line"><span class="stringliteral">Another helper docstring. This is really long.</span></div><div class="line"><span class="stringliteral">And has multiple lines.</span></div><div class="line"><span class="stringliteral">)&quot;&quot;&quot;;</span></div><div class="line"><span class="stringliteral"></span></div><div class="line"><span class="stringliteral">PYBIND11_MODULE(example, m) {</span></div><div class="line"><span class="stringliteral"> m.def(</span><span class="stringliteral">&quot;helper&quot;</span>, []() { <span class="keywordflow">return</span> 42; }, <span class="stringliteral">&quot;My helper method&quot;</span>);</div><div class="line"> m.def(<span class="stringliteral">&quot;another_helper&quot;</span>, []() { <span class="keywordflow">return</span> 10; }, another_helper_doc);</div><div class="line">}</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>Consider using scoped aliases to abbreviate both the usage of bound types and the docstring structures. Borrowing from above:</dd></dl>
277277
<div class="fragment"><div class="line">{</div><div class="line"> <span class="keyword">using</span> Class = RigidTransform&lt;T&gt;;</div><div class="line"> constexpr <span class="keyword">auto</span>&amp; cls_doc = doc.RigidTransform;</div><div class="line"> py::class_&lt;Class&gt;(m, <span class="stringliteral">&quot;RigidTransform&quot;</span>, cls_doc.doc)</div><div class="line"> .def(py::init(), cls_doc.ctor.doc_0args)</div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --><p>To view the documentation rendered in Sphinx: </p><pre class="fragment">bazel run //doc/pydrake:serve_sphinx [-- --browser=false]
278-
</pre><dl class="section note"><dt>Note</dt><dd>Drake's online Python documentation is generated on Ubuntu Jammy, and it is suggested to preview documentation using this platform. Other platforms may have slightly different generated documentation.</dd></dl>
278+
</pre><dl class="section note"><dt>Note</dt><dd>Drake's online Python documentation is generated on Ubuntu Noble, and it is suggested to preview documentation using this platform. Other platforms may have slightly different generated documentation.</dd></dl>
279279
<p>To browse the generated documentation strings that are available for use (or especially, to find out the names for overloaded functions' documentation), generate and open the docstring header: </p><pre class="fragment">bazel build //bindings/pydrake:documentation_pybind.h
280280
$EDITOR bazel-bin/bindings/pydrake/documentation_pybind.h
281281
</pre><p>Search the comments for the symbol of interest, e.g., <code><a class="el" href="classdrake_1_1math_1_1_rigid_transform.html#a8bedd8c483aaf5bc48587d10d7a3d485">drake::math::RigidTransform::RigidTransform</a>&lt;T&gt;</code>, and view the include file and line corresponding to the symbol that the docstring was pulled from.</p>

doxygen_cxx/search/all_13.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doxygen_cxx/search/all_14.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

from_binary.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -261,7 +261,7 @@ <h4 id="macos">macOS</h4>
261261

262262
<h2 id="nightly-releases">Nightly Releases</h2>
263263

264-
<p>Binary packages of Drake for Ubuntu 22.04 (Jammy) and
264+
<p>Binary packages of Drake for Ubuntu 22.04 (Jammy), Ubuntu 24.04 (Noble), and
265265
Mac are generated nightly and are available to download at:</p>
266266

267267
<ul>

from_source.html

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,9 @@ <h1 id="obtaining-the-source-code">Obtaining the Source Code</h1>
166166
<p>Drake’s source code is available on <a href="https://github.com/RobotLocomotion/drake">GitHub</a>.</p>
167167

168168
<p>In addition to the code on <code class="language-plaintext highlighter-rouge">master</code>, the source code archives
169-
are published for each release at
170-
<code class="language-plaintext highlighter-rouge">https://github.com/RobotLocomotion/drake/releases/download/drake-&lt;version&gt;-src.tar.gz</code>
171-
with corresponding .sha256 and .sha512 checksums.
172-
This mirrors GitHub’s source code archive available at
173-
<code class="language-plaintext highlighter-rouge">https://github.com/RobotLocomotion/drake/archive/refs/tags/v&lt;version&gt;.tar.gz</code>,
174-
but checksums are provided for additional stability.</p>
169+
for each release are published at
170+
<code class="language-plaintext highlighter-rouge">https://github.com/RobotLocomotion/drake/releases/download/v&lt;version&gt;/drake-&lt;version&gt;-src.tar.gz</code>
171+
with corresponding .sha256 and .sha512 checksums.</p>
175172

176173
<h1 id="supported-configurations">Supported Configurations</h1>
177174

@@ -246,7 +243,7 @@ <h1 id="supported-configurations">Supported Configurations</h1>
246243
so if it doesn’t work for you then please file a pull request with the fix,
247244
not a bug report.</p>
248245

249-
<p>All else being equal, we would recommend developers use Ubuntu 22.04 (Jammy).</p>
246+
<p>All else being equal, we would recommend developers use Ubuntu 24.04 (Noble).</p>
250247

251248
<p>⁽¹⁾ Drake features that perform image rendering (e.g., camera simulation)
252249
maybe require extra setup. See the

getting_help.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ <h1 id="helpful-information">Helpful Information</h1>
193193
(<code class="language-plaintext highlighter-rouge">helper command in monospace</code>):</p>
194194

195195
<ul>
196-
<li>Operating system (e.g., Ubuntu Jammy 22.04 or macOS Sonoma)</li>
196+
<li>Operating system (e.g., Ubuntu Noble 24.04 or macOS Sonoma)</li>
197197
<li>Installation method (e.g., pip, apt, binary tar.gz, docker image, or
198198
rebuilding from source)</li>
199199
<li>Language you are using (C++ or <a href="/python_bindings.html">Python</a>)

0 commit comments

Comments
 (0)