Publish wp_api docs to GitHub Pages (#749)

Author: oguzkocer

.github/workflows/publish-docs-to-github-pages.yml

@@ -0,0 +1,50 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - trunk
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Configure cache
+        uses: Swatinem/rust-cache@v2
+      - name: Setup pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Clean docs folder
+        run: cargo clean --doc
+      - name: Build docs
+        run: cargo doc -p wp_api --no-deps
+      - name: Add redirect
+        run: echo '<meta http-equiv="refresh" content="0;url=wp_api/index.html">' > target/doc/index.html
+      - name: Remove lock file
+        run: rm target/doc/.lock
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: target/doc
+  deploy:
+    name: Deploy
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

wp_api/src/login.rs

@@ -95,7 +95,7 @@ impl WpApiDetails {
     /// Returns the URL to be used in application password authentication.
     ///
     /// See the "Authorization Flow" section for details:
-    /// https://github.com/WordPress/wordpress-develop/blob/530493396b324f5bed518a494e2843e7fdb020f1/src/wp-includes/rest-api.php#L1099-L1119
+    /// <https://github.com/WordPress/wordpress-develop/blob/530493396b324f5bed518a494e2843e7fdb020f1/src/wp-includes/rest-api.php#L1099-L1119>
     pub fn find_application_passwords_authentication_url(&self) -> Option<String> {
         self.authentication
             .find_application_passwords_authentication_url()
@@ -267,7 +267,7 @@ impl WpApiDetailsAuthenticationMap {
 /// Return a URL to be used in application password authentication.
 ///
 /// See the "Authorization Flow" section for details:
-/// https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/
+/// <https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/>
 #[uniffi::export]
 pub fn create_application_password_authentication_url(
     login_url: Arc<ParsedUrl>,

wp_api/src/login/url_discovery.rs

@@ -253,7 +253,7 @@ pub struct RootWpJson {
 
 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
 pub struct ParseHomepageResult {
-    /// `href` attribute of a link tag if it has `rel` attribute of "https://api.w.org/".
+    /// `href` attribute of a link tag if it has `rel` attribute of "<https://api.w.org/>".
     /// For example:
     /// <link href="http://localhost/wp-json/" rel="https://api.w.org/">
     pub api_root_url_from_link_tag: Option<Arc<ParsedUrl>>,

wp_api/src/request.rs

@@ -647,8 +647,7 @@ impl WpSupportsLocalization for HttpAuthMethodParsingError {
     }
 }
 
-/// Parser based on https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/WWW-Authenticate
-///
+/// Parser based on <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/WWW-Authenticate>
 impl FromStr for HttpAuthMethod {
     type Err = HttpAuthMethodParsingError;
 

wp_api/src/wordpress_org/plugin_directory.rs

@@ -84,7 +84,7 @@ pub struct Ratings {
     pub one_star: u32,
 }
 
-/// https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/#screenshots
+/// <https://developer.wordpress.org/plugins/wordpress-org/plugin-assets/#screenshots>
 #[derive(Serialize, Deserialize, PartialEq, Eq, Debug, uniffi::Enum)]
 #[serde(untagged)]
 pub enum Screenshots {