-
Notifications
You must be signed in to change notification settings - Fork 3
#301: Update PTB and workflows and activate generation of GH pages #302
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.
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
base: main
Are you sure you want to change the base?
Conversation
- name: Setup Python & Poetry Environment | ||
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0 | ||
|
||
- name: Build Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You did the needed actions in Settings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I could have been more specific. For using this GitHub action & deploying the documentation, you'll need to follow these steps: https://github.com/exasol/python-toolbox/blob/main/doc/user_guide/getting_started.rst?plain=1#L182 . I was confirming if you had, as I don't have permissions to double-check it myself 😄
|
||
- name: Build Documentation | ||
run: | | ||
poetry run -- nox -s docs:multiversion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Locally, this command fails for me poetry run -- nox -s docs:multiversion
with ERROR ERROR:exasol.toolbox.sphinx.multiversion.main:No matching refs found!
.
(but poetry run -- nox -s docs:build
, which runs in the PR #checks.yml is ok). I haven't set up documentation for the PTB yet, but I think, as I didn't see the issue in the docs, that this is not an expected error.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I investigated the error. I think the error is caused by the fact that doc/conf.py
is not yet part of any tag or the main branch.
tbx multiversion filters by this file here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think you're right. 😅
fixes #301
Migrates documentation from markdown to sphinx/rst.