Description: Use Sphinx RTD theme rather than unpackaged sphinx-immaterial Forwarded: not-needed Author: Julian Gilbey Last-Update: 2024-11-18 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,5 @@ import openapi_spec_validator +import sphinx_rtd_theme project = "openapi-spec-validator" copyright = "2023, Artur Maciag" @@ -12,52 +13,16 @@ "sphinx.ext.intersphinx", "sphinx.ext.coverage", "sphinx.ext.viewcode", - "sphinx_immaterial", + "sphinx_rtd_theme", ] templates_path = ["_templates"] exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] -html_theme = "sphinx_immaterial" +html_theme = "sphinx_rtd_theme" html_static_path = [] html_title = "openapi-spec-validator" - -html_theme_options = { - "analytics": { - "provider": "google", - "property": "G-SWHTV603PN", - }, - "repo_url": "https://github.com/python-openapi/openapi-spec-validator/", - "repo_name": "openapi-spec-validator", - "icon": { - "repo": "fontawesome/brands/github-alt", - "edit": "material/file-edit-outline", - }, - "palette": [ - { - "media": "(prefers-color-scheme: dark)", - "scheme": "slate", - "primary": "lime", - "accent": "amber", - "scheme": "slate", - "toggle": { - "icon": "material/toggle-switch", - "name": "Switch to light mode", - }, - }, - { - "media": "(prefers-color-scheme: light)", - "scheme": "default", - "primary": "lime", - "accent": "amber", - "toggle": { - "icon": "material/toggle-switch-off-outline", - "name": "Switch to dark mode", - }, - }, - ], - "globaltoc_collapse": False, -} +html_baseurl = "https://github.com/python-openapi/openapi-spec-validator/" --- a/docs/index.rst +++ b/docs/index.rst @@ -20,88 +20,87 @@ Installation ------------ -.. md-tab-set:: +Pip + PyPI (recommended) +^^^^^^^^^^^^^^^^^^^^^^^^ - .. md-tab-item:: Pip + PyPI (recommented) + .. code-block:: console - .. code-block:: console + pip install openapi-spec-validator - pip install openapi-spec-validator +Pip + the source +^^^^^^^^^^^^^^^^ - .. md-tab-item:: Pip + the source + .. code-block:: console - .. code-block:: console - - pip install -e git+https://github.com/python-openapi/openapi-spec-validator.git#egg=openapi_spec_validator + pip install -e git+https://github.com/python-openapi/openapi-spec-validator.git#egg=openapi_spec_validator Usage ----- -.. md-tab-set:: - - .. md-tab-item:: CLI (Command Line Interface) - - .. md-tab-set:: +CLI (Command Line Interface) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - .. md-tab-item:: Executable +* Executable - Straight forward way: + Straight forward way: - .. code-block:: bash + .. code-block:: bash - openapi-spec-validator openapi.yaml + openapi-spec-validator openapi.yaml - pipes way: + pipes way: - .. code-block:: bash + .. code-block:: bash - cat openapi.yaml | openapi-spec-validator - + cat openapi.yaml | openapi-spec-validator - - .. md-tab-item:: Docker +* Docker - .. code-block:: bash + .. code-block:: bash - docker run -v path/to/openapi.yaml:/openapi.yaml --rm pythonopenapi/openapi-spec-validator /openapi.yaml + docker run -v path/to/openapi.yaml:/openapi.yaml --rm pythonopenapi/openapi-spec-validator /openapi.yaml - .. md-tab-item:: Python interpreter +* Python interpreter - .. code-block:: bash + .. code-block:: bash - python -m openapi_spec_validator openapi.yaml + python -m openapi_spec_validator openapi.yaml - Read more about the :doc:`cli`. +Read more about the :doc:`cli`. - .. md-tab-item:: pre-commit hook +pre-commit hook +^^^^^^^^^^^^^^^ - .. code-block:: yaml + .. code-block:: yaml - repos: - - repo: https://github.com/python-openapi/openapi-spec-validator - rev: 0.5.5 # The version to use or 'master' for latest - hooks: - - id: openapi-spec-validator + repos: + - repo: https://github.com/python-openapi/openapi-spec-validator + rev: 0.5.5 # The version to use or 'master' for latest + hooks: + - id: openapi-spec-validator - Read more about the :doc:`hook`. +Read more about the :doc:`hook`. - .. md-tab-item:: Python package +Python package +^^^^^^^^^^^^^^ - .. code-block:: python + .. code-block:: python - from openapi_spec_validator import validate_spec - from openapi_spec_validator.readers import read_from_filename + from openapi_spec_validator import validate_spec + from openapi_spec_validator.readers import read_from_filename - spec_dict, base_uri = read_from_filename('openapi.yaml') + spec_dict, base_uri = read_from_filename('openapi.yaml') - # If no exception is raised by validate_spec(), the spec is valid. - validate_spec(spec_dict) + # If no exception is raised by validate_spec(), the spec is valid. + validate_spec(spec_dict) - validate_spec({'openapi': '3.1.0'}) + validate_spec({'openapi': '3.1.0'}) - Traceback (most recent call last): - ... - OpenAPIValidationError: 'info' is a required property + Traceback (most recent call last): + ... + OpenAPIValidationError: 'info' is a required property - Read more about the :doc:`python`. +Read more about the :doc:`python`. Related projects ---------------- --- a/docs/cli.rst +++ b/docs/cli.rst @@ -1,33 +1,34 @@ CLI (Command Line Interface) ============================ -.. md-tab-set:: +Executable +^^^^^^^^^^ - .. md-tab-item:: Executable + Straight forward way: - Straight forward way: + .. code-block:: bash - .. code-block:: bash + openapi-spec-validator openapi.yaml - openapi-spec-validator openapi.yaml + pipes way: - pipes way: + .. code-block:: bash - .. code-block:: bash + cat openapi.yaml | openapi-spec-validator - - cat openapi.yaml | openapi-spec-validator - +Docker +^^^^^^ - .. md-tab-item:: Docker + .. code-block:: bash - .. code-block:: bash + docker run -v path/to/openapi.yaml:/openapi.yaml --rm pythonopenapi/openapi-spec-validator /openapi.yaml - docker run -v path/to/openapi.yaml:/openapi.yaml --rm pythonopenapi/openapi-spec-validator /openapi.yaml +Python interpreter +^^^^^^^^^^^^^^^^^^ - .. md-tab-item:: Python interpreter + .. code-block:: bash - .. code-block:: bash - - python -m openapi_spec_validator openapi.yaml + python -m openapi_spec_validator openapi.yaml .. code-block:: bash @@ -46,4 +47,3 @@ errors. --schema {2.0,3.0.0,3.1.0,detect} OpenAPI schema (default: detect) -