Skip to content

Conversation

@bryevdv
Copy link
Member

@bryevdv bryevdv commented May 7, 2024

This PR fixes all outstanding sphinx warnings, and also restores the -W passed to sphinx-build to enforce no-warnings.

@tcmetzger I had to get rid of the ** glob and make the html_sidebars config slightly more explicit. Unfortunately I don't think there is any way to avoid this, given the limitations of glob syntax. But there's only a handful of directories and our docs structure does not change often.

I also made some of the sphinxext extensions much more informative, e.g. by changing "<bokeh-prop>" to f"<bokeh-prop: {model_name}.{prop_name}>". I am not sure why it took me 10+ years to realize that was an option...

@mattpap I put in minimal docstrings for bokeh build and bokeh init command. I think these can/should be expanded but I don't intend to do that in this PR.

@mattpap
Copy link
Contributor

mattpap commented May 7, 2024

Scanning through documentation CI job's logs, there are a few complaints, that perhaps should be addressed in separate PR(s):

locale_dir /home/runner/work/bokeh/bokeh/docs/bokeh/source/locales/en/LC_MESSAGES does not exist

(repeats multiple times)

BokehDeprecationWarning: 'tile_providers module' was deprecated in Bokeh 3.0.0 and will be removed, use 'add_tile directly' instead.

The default value for navigation_with_keys will change to False in the next release. If you wish to preserve the old behavior for your site, set navigation_with_keys=True in the html_theme_options dict in your conf.py file. Be aware that navigation_with_keys = True has negative accessibility implications: pydata/pydata-sphinx-theme#1492

The version switcher "https://docs.bokeh.org/switcher.json" file is malformed; at least one of the items is missing the "url" or "version" key

reading sources... [ 21%] docs/examples/interaction/js_callbacks/doc_js_events
WARNING:bokeh.embed.util:
You are generating standalone HTML/JS output, but trying to use real Python
callbacks (i.e. with on_change or on_event). This combination cannot work.

reading sources... [ 44%] docs/examples/plotting/theme_glyphs
ERROR:bokeh.core.validation.check:E-1001 (BAD_COLUMN_NAME): Glyph refers to nonexistent column name. This could either be due to a misspelling or typo, or due to an expected column being missing. : text_font='Helvetica' [no close matches] {renderer: GlyphRenderer(id='p32875', ...)}

And finally the well known:

The HTML pages are in build/html.
cp: cannot stat '../../src/bokeh/server/static': No such file or directory

@mosc9575
Copy link
Contributor

mosc9575 commented May 7, 2024

Because the docs for Windows are working again I suggest to add the -W option to the make.bat-file, too.

%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%\html

@bryevdv
Copy link
Member Author

bryevdv commented May 7, 2024

Some of those are from testing deprecated APIs, so they make sense to be there and will go away when the deprecated APIs go away (speaking of, I think we could drop the tile provider one at this point?) I'll try to look at the other in another PR.

@bryevdv bryevdv merged commit 3ce591f into branch-3.5 May 7, 2024
@bryevdv bryevdv deleted the bv/sphinx-no-warnings branch May 7, 2024 16:17
@mosc9575 mosc9575 mentioned this pull request Jun 12, 2024
11 tasks
mattpap pushed a commit that referenced this pull request Jun 12, 2024
* fix sphing warnings

* update make.bat too
@mattpap mattpap modified the milestones: 3.5, 3.4.2 Jun 12, 2024
Chiemezuo pushed a commit to Chiemezuo/bokeh that referenced this pull request Aug 27, 2024
* fix sphing warnings

* update make.bat too
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants