Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix various sphinx warnings #428

Merged
merged 1 commit into from
May 14, 2024
Merged

Conversation

tshauck
Copy link
Contributor

@tshauck tshauck commented May 14, 2024

Which issue does this PR close?

Part of #370

Rationale for this change

In working towards #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?

./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.

This is what the build looks like on main.

./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-template.md, user-guide/compatibility.md, user-guide/configs-template.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={'deflist', 'colon_fence', '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 14 source files that are out of date
updating environment: [new config] 14 added, 0 changed, 0 removed
reading sources... [100%] user-guide/overview
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/index.rst:51: WARNING: Duplicate explicit target name: "toc.links".
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/compatibility-template.md: WARNING: document isn't included in any toctree
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/configs-template.md: WARNING: document isn't included in any toctree
done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] user-guide/overview
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/contributor-guide/debugging.md:51: WARNING: Pygments lexer name 'JDK8' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/contributor-guide/debugging.md:59: WARNING: Pygments lexer name 'JDK9' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/contributor-guide/debugging.md:132: WARNING: Pygments lexer name 'commandline' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/installation.md:43: WARNING: Pygments lexer name 'commandline' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/installation.md:49: WARNING: Pygments lexer name 'commandline' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/installation.md:56: WARNING: Pygments lexer name 'commandline' is not known
/Users/thauck/personal/code/github.com/tshauck/arrow-datafusion-comet/docs/temp/user-guide/installation.md:64: WARNING: Pygments lexer name 'commandline' is not known
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, 10 warnings.

The HTML pages are in build/html.

Manually reviewed HTML too.

@tshauck tshauck marked this pull request as ready for review May 14, 2024 15:26
Copy link
Member

@andygrove andygrove left a comment

Choose a reason for hiding this comment

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

Thank you for cleaning this up @tshauck

@@ -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"
Copy link
Member

Choose a reason for hiding this comment

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

That is much nicer

@andygrove andygrove merged commit 32b7318 into apache:main May 14, 2024
41 checks passed
@tshauck tshauck deleted the doc-tweaks branch May 14, 2024 20:01
himadripal pushed a commit to himadripal/datafusion-comet that referenced this pull request Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants