Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions codegen/src/doc_model.rs
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,8 @@ impl DocModel {

/// Where `std`'s published documentation is, when `[doc] links` names no
/// other: the hosted docs, a module at `<base>/<module>/` and a unit at
/// its lowercase anchor (`reference/schema/std/http/#httpmethod`).
pub const STD_DOCS: &str = "https://comlineproject.github.io/docs/reference/schema/std/";
/// its lowercase anchor (`reference/package/schema/std/http/#httpmethod`).
pub const STD_DOCS: &str = "https://comlineproject.github.io/docs/reference/package/schema/std/";

/// The base URL of `package`'s published documentation: `[doc] links`'
/// entry for it, else [`STD_DOCS`] for `std`. A dependency without one is
Expand Down
2 changes: 1 addition & 1 deletion codegen/tests/comline_toml_schema.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ formats = ["html", "markdown", "json"]
versions = { last = 5, since = "0.3.0", releases_only = true }
renderer = "render.wasm"
timeout = 30
links = { std = "https://comlineproject.github.io/docs/reference/schema/std/" }
links = { std = "https://comlineproject.github.io/docs/reference/package/schema/std/" }
changelog_from = "0.3.0"
"#;

Expand Down
4 changes: 2 additions & 2 deletions doc-html/tests/golden.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use comline_codegen::protocol::{self, RenderOptions, RenderRequest, Request, Res

fn options() -> RenderOptions {
RenderOptions {
links: BTreeMap::from([("std".to_string(), "https://comlineproject.github.io/docs/reference/schema/std/".to_string())]),
links: BTreeMap::from([("std".to_string(), "https://comlineproject.github.io/docs/reference/package/schema/std/".to_string())]),
..Default::default()
}
}
Expand Down Expand Up @@ -49,7 +49,7 @@ fn dependency_types_link_to_their_docs() {
let files = comline_doc_html::render_json(&model(), &RenderOptions::default()).unwrap();
let get = |p: &str| &files.iter().find(|f| f.path.to_str() == Some(p)).unwrap().contents;
let api = get("api.html");
assert!(api.contains("<a href=\"https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod\"><code>HttpMethod</code></a>"), "{api}");
assert!(api.contains("<a href=\"https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod\"><code>HttpMethod</code></a>"), "{api}");
assert!(api.contains("<a href=\"deps/localdeps/greeting.html#greeting\"><code>Greeting</code></a>"), "{api}");
assert!(api.contains("<a href=\"types.html#customer\"><code>Customer</code></a>"));
// The sidebar: own modules, then an open Dependencies section whose packages are collapsed.
Expand Down
8 changes: 4 additions & 4 deletions doc-html/tests/golden/out/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down Expand Up @@ -83,7 +83,7 @@ <h2><a class="self" href="#order">struct <code>Order</code></a></h2>
<tbody>
<tr><td><code>customer</code></td><td><a href="types.html#customer"><code>Customer</code></a></td></tr>
<tr><td><code>payments</code></td><td><a href="types.html#payment"><code>Payment</code></a><code>[]</code></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>lines</code></td><td>union(<code>u32</code> <code>string</code>)</td></tr>
<tr><td><code>greeting</code></td><td><a href="deps/localdeps/greeting.html#greeting"><code>Greeting</code></a> (optional)</td></tr>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions doc-html/tests/golden/out/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
6 changes: 3 additions & 3 deletions doc-html/tests/golden/out/deps/localdeps/greeting.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
<li><a href="greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
8 changes: 4 additions & 4 deletions doc-html/tests/golden/out/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand All @@ -71,7 +71,7 @@ <h2>Dependencies</h2>
<thead><tr><th>Dependency</th><th>Modules used</th></tr></thead>
<tbody>
<tr><td><code>localdeps</code></td><td><a href="deps/localdeps/greeting.html"><code>greeting</code></a></td></tr>
<tr><td><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> (published docs)</td><td><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></td></tr>
<tr><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> (published docs)</td><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></td></tr>
</tbody>
</table></div>
<p>See the <a href="changelog.html">changelog</a>.</p>
Expand Down
6 changes: 3 additions & 3 deletions doc-html/tests/golden/out/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
8 changes: 4 additions & 4 deletions doc-html/tests/golden/versions-out/0.1.0/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down Expand Up @@ -89,7 +89,7 @@ <h2><a class="self" href="#order">struct <code>Order</code></a></h2>
<tbody>
<tr><td><code>customer</code></td><td><a href="types.html#customer"><code>Customer</code></a></td></tr>
<tr><td><code>payments</code></td><td><a href="types.html#payment"><code>Payment</code></a><code>[]</code></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>lines</code></td><td>union(<code>u32</code> <code>string</code>)</td></tr>
<tr><td><code>greeting</code></td><td><a href="deps/localdeps/greeting.html#greeting"><code>Greeting</code></a> (optional)</td></tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
8 changes: 4 additions & 4 deletions doc-html/tests/golden/versions-out/0.1.0/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand All @@ -77,7 +77,7 @@ <h2>Dependencies</h2>
<thead><tr><th>Dependency</th><th>Modules used</th></tr></thead>
<tbody>
<tr><td><code>localdeps</code></td><td><a href="deps/localdeps/greeting.html"><code>greeting</code></a></td></tr>
<tr><td><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> (published docs)</td><td><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></td></tr>
<tr><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> (published docs)</td><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></td></tr>
</tbody>
</table></div>
</main>
Expand Down
6 changes: 3 additions & 3 deletions doc-html/tests/golden/versions-out/0.1.0/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
8 changes: 4 additions & 4 deletions doc-html/tests/golden/versions-out/0.2.0-dev.1/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down Expand Up @@ -90,7 +90,7 @@ <h2><a class="self" href="#order">struct <code>Order</code></a></h2>
<tbody>
<tr><td><code>customer</code></td><td><a href="types.html#customer"><code>Customer</code></a></td></tr>
<tr><td><code>payments</code></td><td><a href="types.html#payment"><code>Payment</code></a><code>[]</code></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>method</code></td><td><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><code>HttpMethod</code></a></td></tr>
<tr><td><code>lines</code></td><td>union(<code>u32</code> <code>string</code>)</td></tr>
<tr><td><code>greeting</code></td><td><a href="deps/localdeps/greeting.html#greeting"><code>Greeting</code></a> (optional)</td></tr>
</tbody>
Expand Down
6 changes: 3 additions & 3 deletions doc-html/tests/golden/versions-out/0.2.0-dev.1/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
<li><a href="deps/localdeps/greeting.html#greeting"><span class="kind">struct</span> Greeting</a></li>
</ul></details></li>
</ul></details></li>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/" rel="external"><code>std</code></a> <span class="external" aria-label="published docs">↗</span></summary>
<ul>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/schema/std/http/"><code>http</code></a></summary>
<li><details><summary><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/"><code>http</code></a></summary>
<ul>
<li><a href="https://comlineproject.github.io/docs/reference/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
<li><a href="https://comlineproject.github.io/docs/reference/package/schema/std/http/#httpmethod"><span class="kind">enum</span> HttpMethod</a></li>
</ul></details></li>
</ul></details></li>
</ul></details></li>
Expand Down
Loading
Loading