Minor fixes to docs

Include all features in docsrs build, and fix some broken markdown.
FreeOpcUa · Feb 3, 2025 · 8b61d62 · 8b61d62
1 parent 58186f2
commit 8b61d62
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 9 deletions.
diff --git a/async-opcua-macros/Cargo.toml b/async-opcua-macros/Cargo.toml
@@ -28,3 +28,6 @@ proc-macro2 = { workspace = true }
 quote = { workspace = true }
 syn = { workspace = true }
 uuid = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/async-opcua-nodes/Cargo.toml b/async-opcua-nodes/Cargo.toml
@@ -32,3 +32,6 @@ async-opcua-xml = { path = "../async-opcua-xml", optional = true, version = "0.1
 
 [dev-dependencies]
 async-opcua-nodes = { path = ".", features = ["xml"] }
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/async-opcua-server/Cargo.toml b/async-opcua-server/Cargo.toml
@@ -53,4 +53,7 @@ async-opcua-core-namespace = { path = "../async-opcua-core-namespace", optional
 
 
 [dev-dependencies]
-async-opcua-server = { path = ".", features = ["discovery-server-registration", "json"]}
+async-opcua-server = { path = ".", features = ["discovery-server-registration", "json"]}
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/async-opcua-types/Cargo.toml b/async-opcua-types/Cargo.toml
@@ -38,3 +38,6 @@ async-opcua-xml = { path = "../async-opcua-xml", optional = true, version = "0.1
 [dev-dependencies]
 async-opcua-types = { path = ".", features = ["xml", "json"] }
 serde_json = { workspace = true }
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/async-opcua/Cargo.toml b/async-opcua/Cargo.toml
@@ -69,3 +69,6 @@ tokio-util = { workspace = true }
 
 # Include console-logging and json when building tests
 async-opcua = { path = ".", features = ["all", "json", "xml"] }
+
+[package.metadata.docs.rs]
+all-features = true
diff --git a/async-opcua/README.md b/async-opcua/README.md
@@ -66,11 +66,11 @@ Note that this library is split into multiple different crates. OPC-UA is a comp
 
 The `async-opcua` github repo contains a number of samples that may be used as reference when writing your own clients and servers.
 
-1. [`simple-server`](../samples/simple-server) - an OPC-UA server that adds 4 variables v1, v2, v3 and v4 and updates them from a timer via push and pull mechanisms.
-2. [`simple-client`](../samples/simple-client) - an OPC-UA client that connects to a server and subscribes to the values of v1, v2, v3 and v4.
-3. [`discovery-client`](../samples/discovery-client) - an OPC-UA client that connects to a discovery server and lists the servers registered on it.
-4. [`chess-server`](../samples/chess-server) - an OPC-UA server that connects to a chess engine as its back end and updates variables representing the state of the game.
-5. [`demo-server`](../samples/demo-server) - an OPC-UA server that is more complex than the simple server and can be used for compliance testing.
-6. [`mqtt-client`](../samples/mqtt-client) - an OPC-UA client that subscribes to some values and publishes them to an MQTT broker.
-7. [`event-client`](../samples/event-client) - an OPC-UA client that will connect to a server and subscribe to alarms / events.
-8. [`custom-codegen](../samples/custom-codegen) - an OPC-UA server that implements an OPC-UA companion standard generated using `async-opcua-codegen`.
+1. [simple-server](../samples/simple-server) - an OPC-UA server that adds 4 variables v1, v2, v3 and v4 and updates them from a timer via push and pull mechanisms.
+2. [simple-client](../samples/simple-client) - an OPC-UA client that connects to a server and subscribes to the values of v1, v2, v3 and v4.
+3. [discovery-client](../samples/discovery-client) - an OPC-UA client that connects to a discovery server and lists the servers registered on it.
+4. [chess-server](../samples/chess-server) - an OPC-UA server that connects to a chess engine as its back end and updates variables representing the state of the game.
+5. [demo-server](../samples/demo-server) - an OPC-UA server that is more complex than the simple server and can be used for compliance testing.
+6. [mqtt-client](../samples/mqtt-client) - an OPC-UA client that subscribes to some values and publishes them to an MQTT broker.
+7. [event-client](../samples/event-client) - an OPC-UA client that will connect to a server and subscribe to alarms / events.
+8. [custom-codegen](../samples/custom-codegen) - an OPC-UA server that implements an OPC-UA companion standard generated using `async-opcua-codegen`.