Update Sphinx documentation for v1.0 release

- Updated docs/source/conf.py with version 1.0.0 and modern Sphinx configuration
- Enhanced docs/source/index.rst with Python 3.11+ requirements note
- Added comprehensive overview, compatibility, and quick start sections
- Fixed tox.ini docs build command (removed setup.py reference)
- Added docs extras to pyproject.toml with sphinx and sphinx_rtd_theme

Documentation now reflects v1.0 modernization with UV, Ruff, and Python 3.11+ requirements.

Author: tivaliy

docs/source/conf.py

@@ -13,9 +13,25 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+# -- Project information -----------------------------------------------------
+project = "python-gerritclient"
+copyright = "2017-2025, Vitalii Kulanov"
+author = "Vitalii Kulanov"
+
+# The version info for the project
+release = "1.0.0"
+version = "1.0"
+
+# -- General configuration ---------------------------------------------------
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "cliff.sphinxext"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
+    "cliff.sphinxext",
+]
 
 # Options for cliff.sphinxext plugin
 autoprogram_cliff_application = "gerrit"
@@ -26,5 +42,16 @@
 # The master toctree document.
 master_doc = "index"
 
-# General information about the project.
-project = "python-gerritclient"
+# -- Options for HTML output -------------------------------------------------
+html_theme = "sphinx_rtd_theme"
+html_static_path = []
+
+# Intersphinx configuration
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+}
+
+# -- Options for LaTeX output ------------------------------------------------
+latex_documents = [
+    (master_doc, "python-gerritclient.tex", "python-gerritclient Documentation", author, "manual"),
+]

docs/source/index.rst

@@ -5,10 +5,86 @@ python-gerritclient
 This is a CLI tool and Python API wrapper for
 `Gerrit Code Review <https://www.gerritcodereview.com/>`_.
 
-User Documentation
-------------------
+.. note::
+   **Version 1.0+** requires **Python 3.11 or higher**.
+   Python 2.7 and Python 3.5-3.10 are no longer supported.
+
+Overview
+--------
+
+python-gerritclient is a modern Python client for Gerrit Code Review that provides:
+
+* **Command Line Interface**: 88 commands for managing accounts, changes, projects, plugins, and more
+* **Python API**: Clean, pythonic interface for programmatic access
+* **Modern Tooling**: Built with UV and Ruff for blazing fast performance
+* **Production Tested**: Validated against Gerrit 3.13.1 on real-world instances
+
+Compatibility
+-------------
+
+**Gerrit Versions:**
+  - Recommended: Gerrit 3.11+ (tested with 3.13.1)
+  - Supported: Gerrit 2.14+
+  - API Coverage: ~45% of Gerrit REST API
+
+**Python Versions:**
+  - Required: Python 3.11+
+  - Tested: Python 3.11, 3.12, 3.13
+
+Quick Start
+-----------
+
+Installation
+~~~~~~~~~~~~
+
+Using UV (recommended)::
+
+    curl -LsSf https://astral.sh/uv/install.sh | sh
+    uv pip install python-gerritclient
+
+Using pip::
+
+    pip install python-gerritclient
+
+Basic Usage
+~~~~~~~~~~~
+
+Command line::
+
+    gerrit --help
+    gerrit server version
+    gerrit change list "status:open"
+
+Python API::
+
+    from gerritclient import client
+
+    connection = client.connect(
+        "review.example.com",
+        auth_type="digest",
+        username="user",
+        password="pass"
+    )
+
+    group_client = client.get_client('group', connection=connection)
+    members = group_client.get_group_members('core-team')
+
+Documentation
+-------------
 
 .. toctree::
    :maxdepth: 3
 
    cli/index
+
+Additional Resources
+--------------------
+
+* `GitHub Repository <https://github.com/tivaliy/python-gerritclient>`_
+* `Issue Tracker <https://github.com/tivaliy/python-gerritclient/issues>`_
+* `PyPI Package <https://pypi.org/project/python-gerritclient/>`_
+
+License
+-------
+
+Apache License 2.0

pyproject.toml

@@ -42,6 +42,10 @@ test = [
     "oslotest>=5.0.0",
     "testtools>=2.5.0",
 ]
+docs = [
+    "sphinx>=1.6.2",
+    "sphinx_rtd_theme>=1.0.0",
+]
 
 [project.scripts]
 gerrit = "gerritclient.main:main"

tox.ini

@@ -43,8 +43,11 @@ commands =
     {posargs:}
 
 [testenv:docs]
+deps =
+    sphinx>=1.6.2
+    sphinx_rtd_theme
 commands =
-    python setup.py build_sphinx
+    sphinx-build -W -b html docs/source docs/build/html
 
 [flake8]
 show-pep8 = True