Merge pull request #18 from AugmendTech/liam/windows_only_docs_rs

Switch docs.rs to only building windows docs, add link to repo hosted macos docs
AugmendTech · Apr 23, 2024 · aa08325 · aa08325
2 parents 5cd3d3f + ca0b4f9
commit aa08325
Show file tree

Hide file tree

Showing 165 changed files with 224 additions and 174 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "crabgrab"
 description = "A cross-platform screen/window capture crate"
-version = "0.1.2"
+version = "0.1.3"
 edition = "2021"
 authors = ["Augmend, Inc. <https://github.com/AugmendTech>", "Liam Taylor <https://github.com/OutOfTheVoid>", "Tim Misiak <https://github.com/TimMisiak>"]
 documentation = "https://docs.rs/crabgrab"
@@ -15,7 +15,7 @@ exclude = ["spellcheck/", "update_doc_copy.ps1", "update_doc_copy.sh", "docs/",
 
 [package.metadata.docs.rs]
 features = ["iosurface", "metal", "dxgi", "dx11", "bitmap", "screenshot", "wgpu"]
-targets = ["x86_64-apple-darwin", "x86_64-pc-windows-msvc"]
+targets = ["x86_64-pc-windows-msvc"]
 
 [package.metadata.spellcheck]
 config = "spellcheck/cfg.toml"

diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@ A cross-platform screen-capturing crate for rust
 
 [![Crates.io Version](https://img.shields.io/crates/v/crabgrab)](https://crates.io/crates/crabgrab)
 [![docs.rs](https://img.shields.io/docsrs/crabgrab)](https://docs.rs/crabgrab/)
+[MacOS Documentation](https://augmendtech.github.io/CrabGrab/macos_docs/crabgrab/index.html)
 
 
 Capturing video from screens and applications can be very hard, and it's even worse when you want to do it in a cross-platform application. CrabGrab makes it easy to do continuous frame capture that can be used for individual screenshots or for capturing video. It also includes common functionality needed for enumerating screens and applications. You can get from a window to a pixel buffer in just a few lines of code that will work on both Windows and MacOS.
@@ -66,6 +67,10 @@ Note that feature examples will require that feature:
 
 `cargo run --example <example name> --feature <feature name>`
 
+MacOS Docs
+----------
+Unfortuantely due to our dependence on metal-rs, building docs for macos doesn't work on docs.rs, since they use linux containers. As a workaround, we host macos documentation in this repository - link above.
+
 
 Contributions
 -------------

diff --git a/docs/macos_docs/crabgrab/all.html b/docs/macos_docs/crabgrab/all.html
diff --git a/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html b/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html
diff --git a/docs/macos_docs/crabgrab/capturable_content/index.html b/docs/macos_docs/crabgrab/capturable_content/index.html
@@ -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="Enumeration of capturable items"><title>crabgrab::capturable_content - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="crabgrab" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../crabgrab/index.html">crabgrab</a><span class="version">0.1.1</span></h2></div><h2 class="location"><a href="#">Module capturable_content</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section><h2><a href="../index.html">In crate crabgrab</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">crabgrab</a>::<wbr><a class="mod" href="#">capturable_content</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/crabgrab/capturable_content.rs.html#1-258">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>Enumeration of capturable items</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="Enumeration of capturable items"><title>crabgrab::capturable_content - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="crabgrab" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../crabgrab/index.html">crabgrab</a><span class="version">0.1.3</span></h2></div><h2 class="location"><a href="#">Module capturable_content</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section><h2><a href="../index.html">In crate crabgrab</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">crabgrab</a>::<wbr><a class="mod" href="#">capturable_content</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/crabgrab/capturable_content.rs.html#1-258">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>Enumeration of capturable items</p>
 </div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CapturableApplication.html" title="struct crabgrab::capturable_content::CapturableApplication">CapturableApplication</a></div><div class="desc docblock-short">Represents an application with capturable windows</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableContent.html" title="struct crabgrab::capturable_content::CapturableContent">CapturableContent</a></div><div class="desc docblock-short">A collection of capturable content (windows, screens)</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableContentFilter.html" title="struct crabgrab::capturable_content::CapturableContentFilter">CapturableContentFilter</a></div><div class="desc docblock-short">Selects the kind of capturable content to enumerate</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableDisplay.html" title="struct crabgrab::capturable_content::CapturableDisplay">CapturableDisplay</a></div><div class="desc docblock-short">Represents a capturable display</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableDisplayIterator.html" title="struct crabgrab::capturable_content::CapturableDisplayIterator">CapturableDisplayIterator</a></div><div class="desc docblock-short">An iterator over capturable displays</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableWindow.html" title="struct crabgrab::capturable_content::CapturableWindow">CapturableWindow</a></div><div class="desc docblock-short">Represents a capturable application window</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableWindowFilter.html" title="struct crabgrab::capturable_content::CapturableWindowFilter">CapturableWindowFilter</a></div><div class="desc docblock-short">Selects the kind of windows to enumerate for capture</div></li><li><div class="item-name"><a class="struct" href="struct.CapturableWindowIterator.html" title="struct crabgrab::capturable_content::CapturableWindowIterator">CapturableWindowIterator</a></div><div class="desc docblock-short">An iterator over capturable windows</div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.CapturableContentError.html" title="enum crabgrab::capturable_content::CapturableContentError">CapturableContentError</a></div><div class="desc docblock-short">Represents an error that occurred when enumerating capturable content</div></li></ul></section></div></main></body></html>