exasol / bucketfs-python

BucketFS utilities for the Python programming language
https://exasol.github.io/bucketfs-python
MIT License
1 stars 1 forks source link

🐞 Generating and deploying multi version documentation fails #36

Closed Nicoretti closed 4 months ago

Nicoretti commented 1 year ago

Summary

Generating and deploying multi version documentation does not work properly in all scenarios and workflows.

Reproducing the Issue

Scenario 1:

Scenario 2:

Expected Behavior

Entire multi version documentation gets built and deployed to GitHub pages.

Actual Behavior

Documentation build/workflow fails.

Root Cause (optional)

No clear single root cause identified yet.

Leads

There are two major issues which have been identified so far:

  1. The docs build expects a setup/structure which causes a broken rendering of the API docs, otherwise it fails
    /tmp/tmpywesr85d/worktrees/worktree_source/doc/api.rst:4:toctree contains reference to nonexisting document 'api/exasol_bucketfs_utils_python'
  2. The sgpg tool expects different parameters depending if a tag or branch is used as source, therefore the unparamerized github workflow won't work properly in all cases.

Related Issues (optional)

tkilias commented 4 months ago

This bug is obsolete, because we are not using sgpg anymore.