Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Sphinx documentation #532

Merged
merged 3 commits into from
Jul 26, 2023
Merged

Update Sphinx documentation #532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53ba004
Update Sphinx documentation
xDaile Jul 26, 2023
dbb5d25
Update API documentation
xDaile Jul 26, 2023
f19c34e
Add docs build to github CI/CD
xDaile Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/run_tox.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ jobs:
- name: Run unit tests with tox
run: |
tox -m test
- name: Run documentation build test with tox
run: |
tox -m docs
- name: Run security checks with tox
run: |
tox -m security
21 changes: 21 additions & 0 deletions docs/module_documentation/iib.common.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
iib.common package
==================

Submodules
----------

iib.common.tracing module
-------------------------

.. automodule:: iib.common.tracing
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------

.. automodule:: iib.common
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/module_documentation/iib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Subpackages

.. toctree::

iib.common
iib.web
iib.workers

Expand Down
25 changes: 24 additions & 1 deletion docs/module_documentation/iib.web.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ iib.web.errors module
:private-members:
:show-inheritance:

iib.web.iib\_static\_types module
---------------------------------

.. automodule:: iib.web.iib_static_types
:members:
:undoc-members:
:show-inheritance:

iib.web.manage module
---------------------

Expand All @@ -67,6 +75,14 @@ iib.web.manage module
:private-members:
:show-inheritance:

iib.web.messaging module
------------------------

.. automodule:: iib.web.messaging
:members:
:undoc-members:
:show-inheritance:

iib.web.models module
---------------------

Expand All @@ -76,6 +92,14 @@ iib.web.models module
:private-members:
:show-inheritance:

iib.web.s3\_utils module
------------------------

.. automodule:: iib.web.s3_utils
:members:
:undoc-members:
:show-inheritance:

iib.web.utils module
--------------------

Expand All @@ -94,7 +118,6 @@ iib.web.wsgi module
:private-members:
:show-inheritance:


Module contents
---------------

Expand Down
23 changes: 23 additions & 0 deletions docs/module_documentation/iib.workers.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,29 @@ iib.workers.config module
:private-members:
:show-inheritance:

iib.workers.dogpile\_cache module
---------------------------------

.. automodule:: iib.workers.dogpile_cache
:members:
:undoc-members:
:show-inheritance:

iib.workers.greenwave module
----------------------------

.. automodule:: iib.workers.greenwave
:members:
:undoc-members:
:show-inheritance:

iib.workers.s3\_utils module
----------------------------

.. automodule:: iib.workers.s3_utils
:members:
:undoc-members:
:show-inheritance:

Module contents
---------------
Expand Down
71 changes: 63 additions & 8 deletions docs/module_documentation/iib.workers.tasks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,46 @@ iib.workers.tasks.build module
:private-members:
:show-inheritance:

iib.workers.tasks.build\_create\_empty\_index module
----------------------------------------------------

.. automodule:: iib.workers.tasks.build_create_empty_index
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.build\_fbc\_operations module
-----------------------------------------------

.. automodule:: iib.workers.tasks.build_fbc_operations
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.build\_merge\_index\_image module
---------------------------------------------------

.. automodule:: iib.workers.tasks.build_merge_index_image
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.build\_recursive\_related\_bundles module
-----------------------------------------------------------

.. automodule:: iib.workers.tasks.build_recursive_related_bundles
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.build\_regenerate\_bundle module
--------------------------------------------------

.. automodule:: iib.workers.tasks.build_regenerate_bundle
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.celery module
-------------------------------

Expand All @@ -22,6 +62,14 @@ iib.workers.tasks.celery module
:private-members:
:show-inheritance:

iib.workers.tasks.fbc\_utils module
-----------------------------------

.. automodule:: iib.workers.tasks.fbc_utils
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.general module
--------------------------------

Expand All @@ -31,19 +79,26 @@ iib.workers.tasks.general module
:private-members:
:show-inheritance:

iib.workers.tasks.utils module
------------------------------
iib.workers.tasks.iib\_static\_types module
-------------------------------------------

.. automodule:: iib.workers.tasks.utils
:ignore-module-all:
.. automodule:: iib.workers.tasks.iib_static_types
:members:
:private-members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.iib_static_types module
-----------------------------------------
iib.workers.tasks.opm\_operations module
----------------------------------------

.. automodule:: iib.workers.tasks.iib_static_types
.. automodule:: iib.workers.tasks.opm_operations
:members:
:undoc-members:
:show-inheritance:

iib.workers.tasks.utils module
------------------------------

.. automodule:: iib.workers.tasks.utils
:ignore-module-all:
:members:
:private-members:
Expand Down
20 changes: 15 additions & 5 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,29 @@
celery
boto3
celery
dogpile.cache
flask
flask-login
flask-migrate
flask-sqlalchemy
opentelemetry-api
opentelemetry-exporter-otlp
opentelemetry-instrumentation
opentelemetry-instrumentation-botocore
opentelemetry-instrumentation-celery
xDaile marked this conversation as resolved.
Show resolved Hide resolved
opentelemetry-instrumentation-flask
opentelemetry-instrumentation-logging
opentelemetry-instrumentation-requests
opentelemetry-instrumentation-sqlalchemy
opentelemetry-instrumentation-wsgi
opentelemetry-sdk
operator-manifest
python-qpid-proton
python-memcached
psycopg2-binary
python-memcached
python-qpid-proton
recommonmark
requests
ruamel.yaml
# https://github.com/sphinx-doc/sphinx/issues/2796
sphinx==6.2.0
sphinx==6.2.1
lipoja marked this conversation as resolved.
Show resolved Hide resolved
sphinx_rtd_theme
tenacity
typing-extensions
4 changes: 2 additions & 2 deletions iib/common/tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@

Usage:
@instrument_tracing()
def func():
pass
def func():
pass
yashvardhannanavati marked this conversation as resolved.
Show resolved Hide resolved

"""
import os
Expand Down
34 changes: 33 additions & 1 deletion iib/web/static/api_v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,8 @@ paths:
description: >
An arbitrary JSON object associated with the batch. This is accessed by the
"batch_annotations" key's value on a build request in the batch.
example:
example_batch_annotation: batch:448787
build_requests:
type: array
items:
Expand Down Expand Up @@ -531,6 +533,8 @@ paths:
description: >
An arbitrary JSON object associated with the batch. This is accessed by the
"batch_annotations" key's value on a build request in the batch.
example:
example_batch_annotation: batch:448787
build_requests:
type: array
description: Request objects of type Add or Rm
Expand Down Expand Up @@ -860,6 +864,8 @@ components:
type: object
description: >
An arbitrary JSON object created by the submitter associated with the batch.
example:
example_batch_annotation: batch:448787
state_history:
type: array
items:
Expand Down Expand Up @@ -971,6 +977,8 @@ components:
binary_image:
type: string
example: 'quay.io/operator-framework/upstream-registry-builder:v1.5.9'
description: >
The pull specification of the container image where the opm binary gets copied from.
bundles:
type: array
description: >
Expand Down Expand Up @@ -1052,6 +1060,8 @@ components:
properties:
add_arches:
type: array
description: >
The set of arches to build in addition to the arches from_index is currently built for.
items:
type: string
example:
Expand All @@ -1060,11 +1070,18 @@ components:
binary_image:
type: string
example: 'quay.io/operator-framework/upstream-registry-builder:v1.5.9'
description: >
The pull specification of the container image where the opm binary gets copied from.
from_index:
type: string
example: 'quay.io/iib-stage/iib:4'
description: >
The pull specification of the container image containing the index,
that the index image build will be based from.
operators:
type: array
description: >
A list of strings representing the name of the operators to remove from the index image.
items:
type: string
example:
Expand Down Expand Up @@ -1141,7 +1158,9 @@ components:
example:
quay.io/foo/bar@sha256:123456: quay.io/foo/bar@sha256:654321
related_bundles:
type: object
type: Array of dictionaries
description: >
List, where each item represents a specific bundle related to the request.
properties:
url:
type: string
Expand Down Expand Up @@ -1181,6 +1200,8 @@ components:
quay.io/user/openshift-bundle-example-container@sha256:7d8e5dddad0275bc903b6ef17840f98441b15b8b999609af2c9579960e52080e
related_bundles:
type: object
description: >
List, where each item represents a specific bundle related to the request.
properties:
url:
type: string
Expand All @@ -1195,6 +1216,8 @@ components:
properties:
binary_image:
type: string
description: >
The pull specification of the container image where the opm binary gets copied from.
example: 'quay.io/operator-framework/upstream-registry-builder:v1.5.9'
deprecation_list:
type: array
Expand Down Expand Up @@ -1300,14 +1323,21 @@ components:
properties:
binary_image:
type: string
description: >
The pull specification of the container image where the opm binary gets copied from.
example: 'quay.io/operator-framework/upstream-registry-builder:v1.5.9'
from_index:
type: string
description: >
The pull specification of the container image containing the index,
that the index image build will be based from.
example: 'quay.io/iib-stage/iib:4'
labels:
type: object
additionalProperties:
type: string
description: >
The dict of labels required to be added to a new index image.
example:
version: 'v4.6'
output_fbc:
Expand Down Expand Up @@ -1426,6 +1456,8 @@ components:
- s390x
binary_image:
type: string
description: >
The pull specification of the container image where the opm binary gets copied from.
example: 'quay.io/operator-framework/upstream-registry-builder:v1.26.3'
fbc_fragment:
type: string
Expand Down
Loading