Commit Graph

15 Commits

Author SHA1 Message Date
Nicola Sella 4847d28d7c
Fix Pyupgrades
Fix sys.version_info comparisons and drop unsupported python code

Furthermore, addresses UP008: super-call-with-parameters

Super is not called with parameters anymore when the first argument is
__class__ and the second argument is equivalent to the first argument of
the enclosing method

Signed-off-by: Nicola Sella <nsella@redhat.com>
2025-01-28 15:42:15 +01:00
Nicola Sella 59985eaf97 Fix files to comply with pre-commit
Signed-off-by: Nicola Sella <nsella@redhat.com>
2024-12-03 16:13:54 +01:00
Kanishk Pachauri 7e08da7dbe
fix[docs]: Unindented example code on the index page
Signed-off-by: Kanishk Pachauri <itskanishkp.py@gmail.com>
2024-11-15 23:54:54 +05:30
Jack J. Woehr 6e929b8cdf
Update index.rst Client -> PodmanClient
Signed-off-by: Jack J. Woehr <4604036+jwoehr@users.noreply.github.com>
2024-06-29 19:02:36 -06:00
Urvashi Mohnani 78d57dd116 Fix readthedocs build issues
When the docs were being built on readthedocs, they weren't
showing up because it couldn't find where the generated rst
files were. Fix that and update how the titles are shown in
the sidebar.

Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
2023-11-15 10:46:56 -05:00
Urvashi Mohnani e74fea24b5 Fix docs build
Fix the command to build the docs to ensure that they are
created at the right location so that they show up in readthedocs.

Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
2023-11-07 08:04:06 -05:00
Jhon Honce 59dc162690 Update Makefile to emulate readthedocs automation
Major issue is readthedocs has fixed paths

Signed-off-by: Jhon Honce <jhonce@redhat.com>
Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
2023-06-05 14:48:51 +00:00
Jhon Honce ea0f663b3f Update Sphinx configuration
* Update the URLs for external links to https
* Improve configuration for readthedocs

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-09-24 10:56:52 -07:00
Jhon Honce 49a762894f Bump version for packaging changes
* Fixme dependencies in pyproject.toml
* Move version.py to prevent packaging issues
* Publish non-arch source to PyPi
* Bump version to 3.1.2.5

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-21 12:18:33 -07:00
Jhon Honce 46c65cc472 Bump version for packaging changes
* Add all dependencies to pyproject.toml

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-18 14:11:14 -07:00
Jhon Honce 834b223480 Bump version for tagging release
Need bump for changes in dependency version checking

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-14 10:10:53 -07:00
Jhon Honce 3f9955d23c Cleanup docstrings and generated html pages for API
* Overused Notes in docstrings.
* Change Literal import to not mask which Literal is being used
* Reduced number of warnings from sphinx-build
* Fixed type hints for @properties

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-06 17:24:54 -07:00
Jhon Honce 115a27f0dd Sphinx configured to process docstrings
* Sphinx configured to create html documentation from docstrings on API.
  Low level and deprecated classes not included in index.
* Downgraded urllib3 in setup.cfg
* Updated some docstrings after seeing the results from Sphinx

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-06 11:22:42 -07:00
Jhon Honce 003423bb01 Introduce sphinx processing for html API web site
* Add docs target to Makefile
* Started updating some docstrings
* Added support for connections from containers.conf
* Ported more uses of XDG_* envvar to xdg package
* Downgrade modules in requirements.txt as needed by RHEL/Fedora
  packaging.

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-05 10:53:17 -07:00
Jhon Honce 2eebfac8b9 Introduce sphinx processing for html API web site
* Add docs target to Makefile
* Started updating some docstrings
* Added support for connections from containers.conf
* Ported more uses of XDG_* envvar to xdg package

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2021-05-04 14:43:18 -07:00