Replace add_javascript with add_js_file in Sphinx configuration script
#4363
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
May 17, 2021
Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
harupy
commented
May 17, 2021
| html_add_permalinks = " " | ||
| html_permalinks_icon = " " |
There was a problem hiding this comment.
Fix for:
WARNING: html_add_permalinks has been deprecated since v3.5.0. Please use html_permalinks and html_permalinks_icon instead.
harupy
commented
May 17, 2021
| app.add_javascript(JS_FILE) | ||
| app.add_js_file(JS_FILE) |
There was a problem hiding this comment.
Fix for:
Handler <function add_assets at 0x7efeadbe8ea0> for event 'builder-inited' threw an exception (exception: 'Sphinx' object has no attribute 'add_javascript')
|
@WeichenXu123 Thanks! |
27 tasks
27 tasks
YQ-Wang
pushed a commit
to YQ-Wang/mlflow
that referenced
this pull request
May 29, 2021
…cript (mlflow#4363) * make sure docs build fails Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use add_js_file Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use html_permalinks Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use bool Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * Use html_permalinks_icon Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> Signed-off-by: Yiqing Wang <yiqing@wangemail.com>
harupy
added a commit
to wamartin-aml/mlflow
that referenced
this pull request
Jun 7, 2021
…cript (mlflow#4363) * make sure docs build fails Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use add_js_file Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use html_permalinks Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * use bool Signed-off-by: harupy <17039389+harupy@users.noreply.github.com> * Use html_permalinks_icon Signed-off-by: harupy <17039389+harupy@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: harupy 17039389+harupy@users.noreply.github.com
What changes are proposed in this pull request?
The current sphinx configuration script contains function or variables that no longer exist in the latest version of Sphinx (4.0.1). This PR replace them with valid ones.
https://app.circleci.com/pipelines/github/mlflow/mlflow/5602/workflows/f99cdd2b-109a-41a3-b43f-80d09af3ee97/jobs/7502
How is this patch tested?
Ensure the doc build successfully completes
Release Notes
Is this a user-facing change?
(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/artifacts: Artifact stores and artifact loggingarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesarea/examples: Example codearea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/models: MLmodel format, model serialization/deserialization, flavorsarea/projects: MLproject format, project running backendsarea/scoring: Local serving, model deployment tools, spark UDFsarea/server-infra: MLflow server, JavaScript dev serverarea/tracking: Tracking Service, tracking client APIs, autologgingInterface
area/uiux: Front-end, user experience, JavaScript, plottingarea/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Modelsarea/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registryarea/windows: Windows supportLanguage
language/r: R APIs and clientslanguage/java: Java APIs and clientslanguage/new: Proposals for new client languagesIntegrations
integrations/azure: Azure and Azure ML integrationsintegrations/sagemaker: SageMaker integrationsintegrations/databricks: Databricks integrationsHow should the PR be classified in the release notes? Choose one:
rn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/none- No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notes