Setup Poetry and Bumpversion #110
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…to main and on Pypi to release the final version
Jackal08
reviewed
Apr 28, 2024
| - pip install poetry | ||
| post_install: | ||
| # Install dependencies | ||
| - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --only docs |
There was a problem hiding this comment.
This is an env variable? What should it be set to?
There was a problem hiding this comment.
$READTHEDOCS_VIRTUALENV_PATH is a predefined env variable set by Read the Docs in the build environment. It's the path to the virtual env used by 'Read the Docs' when building the project's documentation.
There was a problem hiding this comment.
|
|
||
| - name: Publish to TestPyPI | ||
| env: | ||
| POETRY_PYPI_TOKEN_TESTPYPI: ${{ secrets.TEST_PYPI_API_TOKEN }} |
There was a problem hiding this comment.
I need to setup and test this env variable + build. Will take me about a week.
|
|
||
| - name: Publish to TestPyPI | ||
| env: | ||
| POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_API_TOKEN }} |
There was a problem hiding this comment.
I need to setup and test this env variable + build. Will take me about a week.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This pull request fixes problems related to documentation issues and refactors bumpversion.cfg
Approach
The new version of sphinx-rtd-theme has been updated to avoid any issues with the docs build.
The new .readthedocs.yml file complies with the poetry package manager.
The import was shortened to build the docs without any long module names.
Tests for New Behavior
None.
Checklist
None.
Learning
None