Skip to content

Commit

Permalink
🚀 update docs from verso repository
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 19, 2024
1 parent 2361f36 commit afc4a17
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/search-index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/search.desc/versoview/versoview-desc-0-.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/src/versoview/compositor.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -2208,7 +2208,7 @@
<span class="kw">use </span>gleam::gl;
<span class="kw">use </span>ipc_channel::ipc::{<span class="self">self</span>, IpcSharedMemory};
<span class="kw">use </span>log::{debug, error, trace, warn};
<span class="kw">use </span>profile_traits::time::{<span class="self">self </span><span class="kw">as </span>profile_time, profile, ProfilerCategory};
<span class="kw">use </span>profile_traits::time::{<span class="self">self </span><span class="kw">as </span>profile_time, ProfilerCategory};
<span class="kw">use </span>profile_traits::{mem, time, time_profile};
<span class="kw">use </span>script_traits::CompositorEvent::{MouseButtonEvent, MouseMoveEvent, TouchEvent, WheelEvent};
<span class="kw">use </span>script_traits::{
Expand Down
26 changes: 24 additions & 2 deletions docs/src/versoview/config.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,17 @@
<a href="#333" id="333">333</a>
<a href="#334" id="334">334</a>
<a href="#335" id="335">335</a>
<a href="#336" id="336">336</a>
<a href="#337" id="337">337</a>
<a href="#338" id="338">338</a>
<a href="#339" id="339">339</a>
<a href="#340" id="340">340</a>
<a href="#341" id="341">341</a>
<a href="#342" id="342">342</a>
<a href="#343" id="343">343</a>
<a href="#344" id="344">344</a>
<a href="#345" id="345">345</a>
<a href="#346" id="346">346</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>std::{fs, path::PathBuf};

<span class="kw">use </span>embedder_traits::resources::{<span class="self">self</span>, Resource, ResourceReaderMethods};
Expand Down Expand Up @@ -374,6 +385,8 @@
<span class="doccomment">/// Path to resource directory. If None, Verso will try to get default directory. And if that
/// still doesn't exist, all resource configuration will set to default values.
</span><span class="kw">pub </span>resource_dir: <span class="prelude-ty">Option</span>&lt;PathBuf&gt;,
<span class="doccomment">/// Override the user agent
</span><span class="kw">pub </span>user_agent: <span class="prelude-ty">Option</span>&lt;String&gt;,
}

<span class="doccomment">/// Configuration of Verso instance.
Expand Down Expand Up @@ -426,6 +439,13 @@
<span class="string">"out.html"</span>,
);

opts.optopt(
<span class="string">""</span>,
<span class="string">"user-agent"</span>,
<span class="string">"Override the user agent"</span>,
<span class="string">"'VersoView/1.0'"</span>,
);

opts.optopt(
<span class="string">"w"</span>,
<span class="string">"width"</span>,
Expand Down Expand Up @@ -494,6 +514,8 @@
<span class="prelude-val">None
</span>};

<span class="kw">let </span>user_agent = matches.opt_str(<span class="string">"user-agent"</span>);

<span class="kw">let </span><span class="kw-2">mut </span>window_attributes = winit::window::Window::default_attributes();

<span class="kw">let </span>width = matches.opt_get::&lt;u32&gt;(<span class="string">"width"</span>).unwrap_or_else(|e| {
Expand Down Expand Up @@ -551,12 +573,12 @@
window_attributes,
devtools_port,
profiler_settings,
user_agent,
})
}

<span class="kw">impl </span>Config {
<span class="doccomment">/// Create a new configuration for creating Verso instance. It must provide the path of
/// resources directory.
<span class="doccomment">/// Create a new configuration for creating Verso instance.
</span><span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<span class="kw">let </span><span class="kw-2">mut </span>opts = default_opts();
<span class="kw">let </span>args = parse_cli_args().unwrap_or_default();
Expand Down
14 changes: 12 additions & 2 deletions docs/src/versoview/verso.rs.html
Original file line number Diff line number Diff line change
Expand Up @@ -717,6 +717,11 @@
<a href="#717" id="717">717</a>
<a href="#718" id="718">718</a>
<a href="#719" id="719">719</a>
<a href="#720" id="720">720</a>
<a href="#721" id="721">721</a>
<a href="#722" id="722">722</a>
<a href="#723" id="723">723</a>
<a href="#724" id="724">724</a>
</pre></div><pre class="rust"><code><span class="kw">use </span>std::{
borrow::Cow,
collections::HashMap,
Expand Down Expand Up @@ -827,6 +832,12 @@
<span class="kw">let </span>initial_url = config.args.url.clone();
<span class="kw">let </span>with_panel = !config.args.no_panel;
<span class="kw">let </span>window_settings = config.args.window_attributes.clone();
<span class="kw">let </span>user_agent: Cow&lt;<span class="lifetime">'static</span>, str&gt; = config
.args
.user_agent
.clone()
.unwrap_or_else(|| default_user_agent_string().to_string())
.into();

config.init();
<span class="comment">// Reserving a namespace to create TopLevelBrowsingContextId.
Expand Down Expand Up @@ -994,8 +1005,7 @@
BluetoothThreadFactory::new(embedder_sender.clone());

<span class="comment">// Create resource thread pool
</span><span class="kw">let </span>user_agent: Cow&lt;<span class="lifetime">'static</span>, str&gt; = default_user_agent_string().into();
<span class="kw">let </span>(public_resource_threads, private_resource_threads) =
</span><span class="kw">let </span>(public_resource_threads, private_resource_threads) =
resource_thread::new_resource_threads(
user_agent.clone(),
devtools_sender.clone(),
Expand Down
2 changes: 1 addition & 1 deletion docs/versoview/config/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Utilities to read options and preferences."><title>versoview::config - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="versoview" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../versoview/index.html">versoview</a><span class="version">0.0.1</span></h2></div><h2 class="location"><a href="#">Module config</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate versoview</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">versoview</a>::<wbr><a class="mod" href="#">config</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/versoview/config.rs.html#1-335">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Utilities to read options and preferences.</p>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Utilities to read options and preferences."><title>versoview::config - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="versoview" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../versoview/index.html">versoview</a><span class="version">0.0.1</span></h2></div><h2 class="location"><a href="#">Module config</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li></ul></section><h2><a href="../index.html">In crate versoview</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">versoview</a>::<wbr><a class="mod" href="#">config</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/versoview/config.rs.html#1-346">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Utilities to read options and preferences.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CliArgs.html" title="struct versoview::config::CliArgs">CliArgs</a></div><div class="desc docblock-short">Command line arguments.</div></li><li><div class="item-name"><a class="struct" href="struct.Config.html" title="struct versoview::config::Config">Config</a></div><div class="desc docblock-short">Configuration of Verso instance.</div></li><li><div class="item-name"><a class="struct" href="struct.ProfilerSettings.html" title="struct versoview::config::ProfilerSettings">ProfilerSettings</a></div><div class="desc docblock-short">Servo time profile settings</div></li></ul></section></div></main></body></html>
Loading

0 comments on commit afc4a17

Please # to comment.