Update documentation

Signed-off-by: Nikola Forró <nforro@redhat.com>
rebase-helper · Jan 18, 2023 · 7fa4af6 · 7fa4af6
1 parent 7991d20
commit 7fa4af6
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 31 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+  apt_packages:
+    - libkrb5-dev
+    - libcurl4-openssl-dev
+    - rpm
+    - cython3
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: doc-requirements-gssapi.txt
+    - requirements: doc-requirements.txt
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/doc-requirements-gssapi.txt b/doc-requirements-gssapi.txt
@@ -0,0 +1 @@
+https://github.com/pythongssapi/python-gssapi/archive/refs/tags/v1.8.0.tar.gz
diff --git a/docs/api/helpers/macrohelper.rst b/docs/api/helpers/macrohelper.rst
diff --git a/docs/api/spec_content.rst b/docs/api/spec_content.rst
diff --git a/docs/api/tags.rst b/docs/api/tags.rst
diff --git a/docs/user_guide/writing_plugins.rst b/docs/user_guide/writing_plugins.rst
@@ -45,7 +45,8 @@ Example
            :param spec_file: SpecFile object representing original SPEC file
            :param rebase_spec_file: SpecFile object representing rebased SPEC file
            """
-           rebase_spec_file.spec_content.section('%package').insert(0, '# processed by {}\n'.format(cls.NAME))
+           with rebase_spec_file.spec.sections() as sections:
+               sections.package.insert(0, '# processed by {}\n'.format(cls.NAME))
            rebase_spec_file.save()
 
 .. code-block:: python