You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@datafusion.apache.org by "tshauck (via GitHub)" <gi...@apache.org> on 2024/05/14 15:24:03 UTC
[PR] docs: fix various sphinx warnings [datafusion-comet]
tshauck opened a new pull request, #428:
URL: https://github.com/apache/datafusion-comet/pull/428
## Which issue does this PR close?
Part of https://github.com/apache/datafusion-comet/issues/370
## Rationale for this change
In working towards https://github.com/apache/datafusion-comet/pull/422 I noticed a few warnings when building the docs. This PR fixes those warnings and makes a few other tweaks (e.g. `Intellij` -> `IntelliJ`)
## What changes are included in this PR?
Only doc changes.
## How are these changes tested?
```console
./build.sh
Running Sphinx v7.1.2
making output directory... done
[autosummary] generating autosummary for: contributor-guide/contributing.md, contributor-guide/debugging.md, contributor-guide/development.md, contributor-guide/plugin_overview.md, index.rst, user-guide/compatibility.md, user-guide/configs.md, user-guide/datatypes.md, user-guide/expressions.md, user-guide/installation.md, user-guide/operators.md, user-guide/overview.md
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'colon_fence', 'deflist', 'tasklist'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=3, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 12 source files that are out of date
updating environment: [new config] 12 added, 0 changed, 0 removed
reading sources... [100%] user-guide/overview
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] user-guide/overview
generating indices... genindex done
highlighting module code...
writing additional pages... search done
copying images... [100%] _static/images/comet-system-diagram.png
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in build/html.
```
Manually reviewed HTML 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] docs: fix various sphinx warnings [datafusion-comet]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove commented on code in PR #428:
URL: https://github.com/apache/datafusion-comet/pull/428#discussion_r1600398803
##########
spark/src/main/scala/org/apache/comet/GenerateDocs.scala:
##########
@@ -40,7 +40,7 @@ object GenerateDocs {
}
private def generateConfigReference(): Unit = {
- val templateFilename = "docs/source/user-guide/configs-template.md"
+ val templateFilename = "docs/templates/configs-template.md"
Review Comment:
That is much nicer
--
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] docs: fix various sphinx warnings [datafusion-comet]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove merged PR #428:
URL: https://github.com/apache/datafusion-comet/pull/428
--
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