Merge pull request #83 from valkey-io/aiven-sal/doc

docs: hide unsupported commands and fix copyright

Author: aiven-sal

docs/conf.py

@@ -66,7 +66,7 @@
 # General information about the project.
 project = "valkey-py"
 current_year = datetime.datetime.now().year
-copyright = f"{current_year}, Valkey Inc"
+copyright = f"{current_year}, Redis Ltd"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -229,7 +229,7 @@
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ("index", "valkey-py.tex", "valkey-py Documentation", "Valkey Inc", "manual")
+    ("index", "valkey-py.tex", "valkey-py Documentation", "Valkey", "manual")
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -273,7 +273,7 @@
         "index",
         "valkey-py",
         "valkey-py Documentation",
-        "Valkey Inc",
+        "Valkey",
         "valkey-py",
         "One line description of project.",
         "Miscellaneous",
@@ -290,6 +290,6 @@
 # texinfo_show_urls = 'footnote'
 
 epub_title = "valkey-py"
-epub_author = "Valkey Inc"
-epub_publisher = "Valkey Inc"
-epub_copyright = "2023, Valkey Inc"
+epub_author = "Valkey"
+epub_publisher = "Valkey"
+epub_copyright = "2023, Redis Ltd"

valkey/commands/core.py

@@ -5103,6 +5103,10 @@ def hexpire(
         lt: bool = False,
     ) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Sets or updates the expiration time for fields within a hash key, using relative
         time in seconds.
 
@@ -5164,6 +5168,10 @@ def hpexpire(
         lt: bool = False,
     ) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Sets or updates the expiration time for fields within a hash key, using relative
         time in milliseconds.
 
@@ -5225,6 +5233,10 @@ def hexpireat(
         lt: bool = False,
     ) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Sets or updates the expiration time for fields within a hash key, using an
         absolute Unix timestamp in seconds.
 
@@ -5292,6 +5304,10 @@ def hpexpireat(
         lt: bool = False,
     ) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Sets or updates the expiration time for fields within a hash key, using an
         absolute Unix timestamp in milliseconds.
 
@@ -5350,6 +5366,10 @@ def hpexpireat(
 
     def hpersist(self, name: KeyT, *fields: str) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Removes the expiration time for each specified field in a hash.
 
         For more information, see https://redis.io/commands/hpersist
@@ -5370,6 +5390,10 @@ def hpersist(self, name: KeyT, *fields: str) -> ResponseT:
 
     def hexpiretime(self, key: KeyT, *fields: str) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Returns the expiration times of hash fields as Unix timestamps in seconds.
 
         For more information, see https://redis.io/commands/hexpiretime
@@ -5393,6 +5417,10 @@ def hexpiretime(self, key: KeyT, *fields: str) -> ResponseT:
 
     def hpexpiretime(self, key: KeyT, *fields: str) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Returns the expiration times of hash fields as Unix timestamps in milliseconds.
 
         For more information, see https://redis.io/commands/hpexpiretime
@@ -5416,6 +5444,10 @@ def hpexpiretime(self, key: KeyT, *fields: str) -> ResponseT:
 
     def httl(self, key: KeyT, *fields: str) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Returns the TTL (Time To Live) in seconds for each specified field within a hash
         key.
 
@@ -5439,6 +5471,10 @@ def httl(self, key: KeyT, *fields: str) -> ResponseT:
 
     def hpttl(self, key: KeyT, *fields: str) -> ResponseT:
         """
+        :meta private:
+
+        Command not available in Valkey
+
         Returns the TTL (Time To Live) in milliseconds for each specified field within a
         hash key.