DOC: add the 'domain' option to the docs#80
Merged
larsoner merged 3 commits intoscientific-python:masterfrom Aug 7, 2025
Merged
DOC: add the 'domain' option to the docs#80larsoner merged 3 commits intoscientific-python:masterfrom
larsoner merged 3 commits intoscientific-python:masterfrom
Conversation
stefanv
reviewed
Jul 24, 2025
stefanv
reviewed
Jul 24, 2025
|
|
||
| ## Example usage | ||
|
|
||
| Sample `.github/workflows/main.yml`: |
Member
There was a problem hiding this comment.
I'm curious, don't you think it's useful to know where this typically is placed?
Member
Author
There was a problem hiding this comment.
Ahh, ok. There used to be a main.yml file here that evolved and I didn't think it was useful to refer to that one. But I can add this back with a more descriptive filename instead.
stefanv
reviewed
Jul 24, 2025
README.md
Outdated
| artifact-path: 0/test_artifacts/root_artifact.md | ||
| circleci-jobs: build_doc | ||
| job-title: Check the rendered docs here! | ||
| domain: output.circle-artifacts.com # or a proxy address to work around routing issues |
Member
There was a problem hiding this comment.
My recommendation would probably to leave it blank, not to fill it with the default value.
Member
Author
There was a problem hiding this comment.
is blank an accepted option?
Member
There was a problem hiding this comment.
Erm, I'm not sure... I guess blank will overwrite the default? But I haven't tried!
Collaborator
|
Comments addressed, thanks @bsipocz ! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I tagged the release before noticing the docs didn't end up in the README page. (Also did a minor cleanup as things got renamed, but then I don't see much sense in referring to the status.yml in the readme)