Documentation improvements

.github/workflows/ci.yml

@@ -47,7 +47,8 @@ jobs:
         shell: bash
         if: matrix.rust == 'nightly'
         run: |
-          echo "RUSTFLAGS=--cap-lints=warn" >> $GITHUB_ENV
+          echo "RUSTFLAGS=--cap-lints=warn --cfg doc_cfg" >> $GITHUB_ENV
+          echo "RUSTDOCFLAGS=--cfg doc_cfg" >> $GITHUB_ENV
 
       - name: Install postgres (Linux)
         if: runner.os == 'Linux' && matrix.backend == 'postgres'
@@ -204,7 +205,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --manifest-path diesel/Cargo.toml --no-default-features --features "${{ matrix.backend }} unstable extras"
+          args: --manifest-path diesel/Cargo.toml --no-default-features --features "${{ matrix.backend }} unstable extras i-implement-a-third-party-backend-and-opt-into-breaking-changes"
 
       - name: Test diesel
         if: matrix.rust != 'nightly'
@@ -299,7 +300,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: doc
-          args: --manifest-path diesel/Cargo.toml --no-deps --no-default-features --features "${{ matrix.backend }} unstable"
+          args: --manifest-path diesel/Cargo.toml --no-deps --no-default-features --features "${{ matrix.backend }} unstable i-implement-a-third-party-backend-and-opt-into-breaking-changes"
 
       - name: Run rustdoc
         if: matrix.run != 'nightly'

.github/workflows/doc.yml

@@ -28,18 +28,19 @@ jobs:
         echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
     - uses: actions-rs/toolchain@v1
       with:
-        toolchain: stable
+        toolchain: nightly
         profile: minimal
         override: true
     - name: Install dependencies
       run: |
         sudo apt-get update
         sudo apt-get -y install libmysqlclient-dev libsqlite3-dev libpq-dev
     - name: Build documentation
-      uses: actions-rs/cargo@v1
-      with:
-        command: doc
-        args: --manifest-path diesel/Cargo.toml --features "postgres sqlite mysql extras" --workspace
+      env:
+        RUSTFLAGS: "--cfg doc_cfg"
+        RUSTDOCFLAGS: "--cfg doc_cfg"
+      run:
+        cargo +nightly doc --manifest-path diesel/Cargo.toml --features "postgres sqlite mysql extras i-implement-a-third-party-backend-and-opt-into-breaking-changes" --workspace
 
     - name: Publish documentation
       if: success()

diesel/Cargo.toml

@@ -1,14 +1,14 @@
 [package]
 name = "diesel"
 version = "2.0.0"
-authors = ["Sean Griffin <[email protected]>"]
+authors = ["Sage Griffin <[email protected]>"]
 license = "MIT OR Apache-2.0"
 description = "A safe, extensible ORM and Query Builder for PostgreSQL, SQLite, and MySQL"
 readme = "README.md"
 documentation = "https://docs.rs/diesel/"
 homepage = "https://diesel.rs"
 repository = "https://github.com/diesel-rs/diesel"
-keywords = ["orm", "database", "blockchain", "sql"]
+keywords = ["orm", "database", "sql"]
 categories = ["database"]
 edition = "2018"
 
@@ -55,14 +55,17 @@ huge-tables = ["64-column-tables"]
 postgres = ["pq-sys", "postgres_backend"]
 sqlite = ["libsqlite3-sys", "diesel_derives/sqlite"]
 mysql = ["mysqlclient-sys", "url", "percent-encoding", "bitflags", "mysql_backend"]
-without-deprecated = []
-with-deprecated = []
+without-deprecated = ["diesel_derives/without-deprecated"]
+with-deprecated = ["diesel_derives/with-deprecated"]
 network-address = ["ipnetwork", "libc"]
 numeric = ["num-bigint", "bigdecimal", "num-traits", "num-integer"]
 postgres_backend = ["diesel_derives/postgres", "bitflags", "byteorder"]
 mysql_backend = ["diesel_derives/mysql", "byteorder"]
 returning_clauses_for_sqlite_3_35 = []
+i-implement-a-third-party-backend-and-opt-into-breaking-changes = []
 
 [package.metadata.docs.rs]
 features = ["postgres", "mysql", "sqlite", "extras"]
 no-default-features = true
+rustc-args = ["--cfg", "doc_cfg"]
+rustdoc-args = ["--cfg", "doc_cfg"]