You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "AmosAidoo (via GitHub)" <gi...@apache.org> on 2025/03/01 00:42:12 UTC
[PR] Myst warnings [datafusion]
AmosAidoo opened a new pull request, #14952:
URL: https://github.com/apache/datafusion/pull/14952
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
-->
- Closes #14945.
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
-->
docs/build.sh produces warnings. This change removes all those warnings and treats subsequent warnings as errors and will cause the CI to fail.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
-->
- Replaces invalid links with valid ones.
- Respects heading hierarchy.
- Adds `-W` flag to `sphinx-build` which treats warnings as errors.
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
-->
Yes, by running the command with `-W` without any build errors. I also checked the output html after build.
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!--
If there are any breaking changes to public APIs, please add the `api change` label.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2695522186
Thanks @AmosAidoo -- much appreciated.
I pushed a commit 95707f6 to run build.sh as part of CI too
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#discussion_r1977650215
##########
docs/build.sh:
##########
@@ -28,4 +28,4 @@ sed -i -e 's/\.\.\/\.\.\/\.\.\//https:\/\/github.com\/apache\/arrow-datafusion\/
python rustdoc_trim.py
-make SOURCEDIR=`pwd`/temp html
+make SOURCEDIR=`pwd`/temp SPHINXOPTS=-W html
Review Comment:
❤️
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2695939626
> Does this still happen for you? Maybe I can check why if there is some additional context as well.
Sorry -- I should have posted an update -- I ran `pip install --force -r requirements.txt` and that seems to have solved it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "AmosAidoo (via GitHub)" <gi...@apache.org>.
AmosAidoo commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2695648531
> Interestingly, I ran this locally and got the following error:
>
> ```shell
> $ cd docs
> $ ./build.sh
> Processing file: temp/library-user-guide/adding-udfs.md
> Done processing file: temp/library-user-guide/adding-udfs.md
> ...
> Warning, treated as error:
> /Users/andrewlamb/Software/datafusion/docs/temp/library-user-guide/adding-udfs.md:365:Pygments lexer name 'csv' is not known
> make: *** [html] Error 2
> ```
Does this still happen for you? Maybe I can check why if there is some additional context as well.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #14952:
URL: https://github.com/apache/datafusion/pull/14952
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "AmosAidoo (via GitHub)" <gi...@apache.org>.
AmosAidoo commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2697309878
@alamb my pleasure
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2695514120
Interestingly, I ran this locally and got the following error:
```shell
$ cd docs
$ ./build.sh
Processing file: temp/library-user-guide/adding-udfs.md
Done processing file: temp/library-user-guide/adding-udfs.md
...
Warning, treated as error:
/Users/andrewlamb/Software/datafusion/docs/temp/library-user-guide/adding-udfs.md:365:Pygments lexer name 'csv' is not known
make: *** [html] Error 2
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org
Re: [PR] Fix documentation warnings and error if anymore occur [datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #14952:
URL: https://github.com/apache/datafusion/pull/14952#issuecomment-2697238917
Thanks again @AmosAidoo -- this is a great improvement in our documentation
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org