Add single_version config to fix URLs. #16
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
ericholscher
commented
Nov 22, 2022
humitos
reviewed
Nov 22, 2022
preview/README.md
Outdated
| @@ -56,3 +56,4 @@ These are all the parameters this action supports: | |||
| * `message-template` (_optional_): Text message to be injected by the action in the Pull Request description. It supports the following placeholders to be replaced: | |||
| * `{docs-pr-index-url}`: URL to the root of the documentation for the Pull Request preview. | |||
| * `platform` (_optional_): Read the Docs Community (`community`) or Read the Docs for Business (`business`). (default: `community`) | |||
| * `single_version` (_optional_): Set this to `'true'` if your project is single version, so we can link to the correct URL. (default: `false`) | |||
There was a problem hiding this comment.
Suggested change
| * `single_version` (_optional_): Set this to `'true'` if your project is single version, so we can link to the correct URL. (default: `false`) | |
| * `single_version` (_optional_): Set this to `true` if your project is single version, so we can link to the correct URL. (default: `false`) |
There was a problem hiding this comment.
Suggested change
| * `single_version` (_optional_): Set this to `'true'` if your project is single version, so we can link to the correct URL. (default: `false`) | |
| * `single_version` (_optional_): Set this to `'true'` (note it's a _string_) if your project is single version, so we can link to the correct URL. (default: `'false'`) |
humitos
reviewed
Nov 23, 2022
There was a problem hiding this comment.
I updated my comments after research a little more about this. It seems it's a problem on GHA and there is no good solution. It's just a string, unfortunately 👎🏼
I'm suggesting to update a little the docs of the single_version and use single-version for consistency. Also, the variable needs to be defined before used.
preview/README.md
Outdated
| @@ -56,3 +56,4 @@ These are all the parameters this action supports: | |||
| * `message-template` (_optional_): Text message to be injected by the action in the Pull Request description. It supports the following placeholders to be replaced: | |||
| * `{docs-pr-index-url}`: URL to the root of the documentation for the Pull Request preview. | |||
| * `platform` (_optional_): Read the Docs Community (`community`) or Read the Docs for Business (`business`). (default: `community`) | |||
| * `single_version` (_optional_): Set this to `'true'` if your project is single version, so we can link to the correct URL. (default: `false`) | |||
There was a problem hiding this comment.
Suggested change
| * `single_version` (_optional_): Set this to `'true'` if your project is single version, so we can link to the correct URL. (default: `false`) | |
| * `single_version` (_optional_): Set this to `'true'` (note it's a _string_) if your project is single version, so we can link to the correct URL. (default: `'false'`) |
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
|
@humitos should be ready 👍 |
humitos
approved these changes
Nov 23, 2022
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
This was referenced Nov 24, 2022
humitos
added a commit
that referenced
this pull request
Jan 30, 2023
* Add single_version config to fix URLs. Fixes #14 * Fix logic * Use var properly * Set RTD_SINGLE_VERSION * Apply suggestions from code review Co-authored-by: Manuel Kaufmann <humitos@gmail.com> * Update preview/README.md Co-authored-by: Manuel Kaufmann <humitos@gmail.com> Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
humitos
added a commit
to readthedocs/website
that referenced
this pull request
Jan 30, 2023
Use the new feature of our own preview action. See readthedocs/actions#16
ericholscher
added a commit
to readthedocs/website
that referenced
this pull request
Jan 30, 2023
* Make the GHA "preview" single version Use the new feature of our own preview action. See readthedocs/actions#16 * Update .github/workflows/documentation-links.yaml Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --------- Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
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.
Fixes #14
📚 Documentation preview 📚: https://readthedocs-preview--16.org.readthedocs.build/en/16/