diff --git a/main/.source b/main/.source index 9b98ed8..edd8455 100644 --- a/main/.source +++ b/main/.source @@ -1,2 +1,2 @@ BRANCH=main -COMMIT_ID=9692e4384b6ba9cbede3ad8510523ebf4f36b830 +COMMIT_ID=81351f7f114d77d13eeb2c76674c2652bac7b6c9 diff --git a/main/_sources/changes/changes_0.1.1.md.txt b/main/_sources/changes/changes_0.1.1.md.txt index 5071a02..eda678f 100644 --- a/main/_sources/changes/changes_0.1.1.md.txt +++ b/main/_sources/changes/changes_0.1.1.md.txt @@ -25,6 +25,7 @@ TBD - #16: Changed path-like parameters from String to Path - #34: Changed "push-enabled" parameter to Bool - #41: Updated importlib_resources and Poetry in GH workflows + - Removed setup.py, installation via wheel from Github or poetry env should be unaffected ## Security @@ -33,8 +34,9 @@ TBD Checked dependencies: * Nox (Code search) * Pytest (Code search + [Tracking-Issue] (https://github.com/pytest-dev/pytest/issues/10392)) - - Dependabot allerts for GitPython, markdown-it-py, Certifi fixed - + - Dependabot alerts for GitPython, markdown-it-py, Certifi fixed + - Dependabot alerts fixed with relock and Poetry updated to 1.8.0 in GitHub actions + ##Documentation - #38: Adjusted documentation to reflect latest changes diff --git a/main/_static/pygments.css b/main/_static/pygments.css index 7547150..c2e07c7 100644 --- a/main/_static/pygments.css +++ b/main/_static/pygments.css @@ -22,6 +22,7 @@ .highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ .highlight .gd { color: #a40000 } /* Generic.Deleted */ .highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #ef2929 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ @@ -101,12 +102,13 @@ body[data-theme="dark"] .highlight .x { color: #d0d0d0 } /* Other */ body[data-theme="dark"] .highlight .p { color: #d0d0d0 } /* Punctuation */ body[data-theme="dark"] .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ body[data-theme="dark"] .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body[data-theme="dark"] .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ +body[data-theme="dark"] .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ body[data-theme="dark"] .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body[data-theme="dark"] .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body[data-theme="dark"] .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body[data-theme="dark"] .highlight .gd { color: #d22323 } /* Generic.Deleted */ body[data-theme="dark"] .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body[data-theme="dark"] .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body[data-theme="dark"] .highlight .gr { color: #d22323 } /* Generic.Error */ body[data-theme="dark"] .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body[data-theme="dark"] .highlight .gi { color: #589819 } /* Generic.Inserted */ @@ -186,12 +188,13 @@ body:not([data-theme="light"]) .highlight .x { color: #d0d0d0 } /* Other */ body:not([data-theme="light"]) .highlight .p { color: #d0d0d0 } /* Punctuation */ body:not([data-theme="light"]) .highlight .ch { color: #ababab; font-style: italic } /* Comment.Hashbang */ body:not([data-theme="light"]) .highlight .cm { color: #ababab; font-style: italic } /* Comment.Multiline */ -body:not([data-theme="light"]) .highlight .cp { color: #cd2828; font-weight: bold } /* Comment.Preproc */ +body:not([data-theme="light"]) .highlight .cp { color: #ff3a3a; font-weight: bold } /* Comment.Preproc */ body:not([data-theme="light"]) .highlight .cpf { color: #ababab; font-style: italic } /* Comment.PreprocFile */ body:not([data-theme="light"]) .highlight .c1 { color: #ababab; font-style: italic } /* Comment.Single */ body:not([data-theme="light"]) .highlight .cs { color: #e50808; font-weight: bold; background-color: #520000 } /* Comment.Special */ body:not([data-theme="light"]) .highlight .gd { color: #d22323 } /* Generic.Deleted */ body:not([data-theme="light"]) .highlight .ge { color: #d0d0d0; font-style: italic } /* Generic.Emph */ +body:not([data-theme="light"]) .highlight .ges { color: #d0d0d0; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ body:not([data-theme="light"]) .highlight .gr { color: #d22323 } /* Generic.Error */ body:not([data-theme="light"]) .highlight .gh { color: #ffffff; font-weight: bold } /* Generic.Heading */ body:not([data-theme="light"]) .highlight .gi { color: #589819 } /* Generic.Inserted */ diff --git a/main/api/exasol_sphinx_github_pages_generator.console.html b/main/api/exasol_sphinx_github_pages_generator.console.html index 88430ac..747f337 100644 --- a/main/api/exasol_sphinx_github_pages_generator.console.html +++ b/main/api/exasol_sphinx_github_pages_generator.console.html @@ -215,14 +215,14 @@
Bases: object
Bases: object
Print a message and newline to stdout or a file. This should be
-used instead of print()
because it provides better support
+used instead of print()
because it provides better support
for different data, files, and environments.
Compared to print()
, this does the following:
Compared to print()
, this does the following:
Ensures that the output encoding is not misconfigured on Linux.
Supports Unicode in the Windows console.
Print a message and newline to stdout or a file. This should be
-used instead of print()
because it provides better support
+used instead of print()
because it provides better support
for different data, files, and environments.
Compared to print()
, this does the following:
Compared to print()
, this does the following:
Ensures that the output encoding is not misconfigured on Linux.
Supports Unicode in the Windows console.
Bases: object
Bases: object
Builds and deploys GitHub Pages using Sphinx given a branch.
Build the html documentation files using “sphinx-apidoc” and “sphinx-build”, then copies them into the target branch. If an older version of the files exist for the source branch, on the target_branch, these are deleted first.
@@ -247,7 +247,7 @@Creates a separate Git worktree for the source_branch if the existing worktree has a different branch currently checked out. This way, the local current Git Repository is kept in its original state. The new worktree is created at self.worktree_paths[“source_worktree”]. @@ -263,7 +263,7 @@
Creates a separate worktree for the target branch and checks it out. If the target_branch already exists in remote, it is checked out into a new local worktree. Else, target_branch is added as a new branch with a separate worktree and set as default for GitHub Pages.
@@ -271,7 +271,7 @@Deletes the temporary worktrees and resets the working directory to the given working directory in order to ensure it points to an existing directory.
Tries to find a valid source_branch. If source_branch is set, checks if it is equal to the current branch. If not, switches branches. Tries to use the current branch if source_branch is not set. Exits if this fails. @@ -294,7 +294,7 @@
Commits and pushes the generated documentation files to the remote GitHUb repository. Also adds a file describing the source branch and commit of the generated files, and generates a release index file using functions in generate_index.py. diff --git a/main/api/exasol_sphinx_github_pages_generator.generate_index.html b/main/api/exasol_sphinx_github_pages_generator.generate_index.html index 5dbf5ec..dd53381 100644 --- a/main/api/exasol_sphinx_github_pages_generator.generate_index.html +++ b/main/api/exasol_sphinx_github_pages_generator.generate_index.html @@ -214,12 +214,12 @@
Uses a given source path “scr_path” given as an importlib_resources.abc.Traversable to copy all files/directories in the directory tree whose root is scr_path into target_path.
Uses a given source path “src_file” given as an importlib_resources.abc.Traversable to copy the file it points to into the destination denoted by target_path.
For the given source_branch find the index.html file in its documentation files, and return its path. Aborts if there are more or less than exactly one (1) index.html file.
Given a list of releases, generate a list of dictionaries containing the name of the release, and the path to its documentation relative to target_worktree. The current release is titled “latest”.
Generates a release index file from a given target_branch into the target_worktree. Uses the “furo” theme for the generated release index file. Source_branch will be called “latest” in the resulting release index. @@ -307,7 +307,7 @@
Find all releases already documented in target_branch, and return them with the path pointing to their index.html file. Additionally, also return the current release and index.html-file-path. The current release is titled “latest”. Found releases are returned as a list of dictionaries. diff --git a/main/changes/changes_0.1.1.html b/main/changes/changes_0.1.1.html index 14d38eb..e338830 100644 --- a/main/changes/changes_0.1.1.html +++ b/main/changes/changes_0.1.1.html @@ -239,6 +239,7 @@
Builds and deploys GitHub Pages using Sphinx given a branch.