Skip to content

Don't send Sphinx build script output to dev/null#14773

Merged
martint merged 1 commit intotrinodb:masterfrom
colebow:colebow/sphinx-build-devnull
Oct 27, 2022
Merged

Don't send Sphinx build script output to dev/null#14773
martint merged 1 commit intotrinodb:masterfrom
colebow:colebow/sphinx-build-devnull

Conversation

@colebow
Copy link
Copy Markdown
Member

@colebow colebow commented Oct 26, 2022

Description

#13688 added a > dev/null to the Sphinx build script, which swallows up the output of trying to build docs. This is pretty counterproductive for anyone working on docs, because if there are any errors or issues when building, you can't see the output of the script to inform you what/where the error is. It looks like one of the other flags added made it much less verbose, anyway, so un-dev-nulling would be extraordinarily helpful.

Non-technical explanation

Make docs easier to work on.

Release notes

(x) This is not user-visible or docs only and no release notes are required.
( ) Release notes are required, please propose a release note for me.
( ) Release notes are required, with the following suggested text:

# Section
* Fix some things. ({issue}`issuenumber`)

Copy link
Copy Markdown
Member

@mosabua mosabua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We essentially need this merged. If the rest of the build somehow requires the piping to dev null we need to add some sort of env variable that switches..

@github-actions github-actions bot added the docs label Oct 26, 2022
Copy link
Copy Markdown
Member

@MiguelWeezardo MiguelWeezardo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if you'd also like to remove -q (quiet flag)

@martint martint merged commit a42f096 into trinodb:master Oct 27, 2022
@colebow
Copy link
Copy Markdown
Member Author

colebow commented Oct 27, 2022

Not sure if you'd also like to remove -q (quiet flag)

I'm happy with that one, it's honestly an improvement.

@github-actions github-actions bot added this to the 402 milestone Oct 27, 2022
@colebow colebow deleted the colebow/sphinx-build-devnull branch January 13, 2023 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

4 participants