format docs

[serena-ruan]

🛠 DevTools 🛠

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/10375/merge

Checkout with GitHub CLI

gh pr checkout 10375

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Format some docs in preparation for markdown conversion

How is this PR tested?

• Existing unit/integration tests
• New unit/integration tests
• Manual tests

Does this PR require documentation update?

• No. You can skip the rest of this section.
• Yes. I've updated:
  • Examples
  • API references
  • Instructions

Release Notes

Is this a user-facing change?

• No. You can skip the rest of this section.
• Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

• area/artifacts: Artifact stores and artifact logging
• area/build: Build and test infrastructure for MLflow
• area/docs: MLflow documentation pages
• area/examples: Example code
• area/gateway: AI Gateway service, Gateway client APIs, third-party Gateway integrations
• area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
• area/models: MLmodel format, model serialization/deserialization, flavors
• area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
• area/projects: MLproject format, project running backends
• area/scoring: MLflow Model server, model deployment tools, Spark UDFs
• area/server-infra: MLflow Tracking server backend
• area/tracking: Tracking Service, tracking client APIs, autologging

Interface

• area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
• area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
• area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
• area/windows: Windows support

Language

• language/r: R APIs and clients
• language/java: Java APIs and clients
• language/new: Proposals for new client languages

Integrations

• integrations/azure: Azure and Azure ML integrations
• integrations/sagemaker: SageMaker integrations
• integrations/databricks: Databricks integrations

How should the PR be classified in the release notes? Choose one:

• rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
• rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
• rn/feature - A new user-facing feature worth mentioning in the release notes
• rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
• rn/documentation - A user-facing documentation change worth mentioning in the release notes

[github-actions]

Documentation preview for 817140d will be available here when this CircleCI job completes successfully.

More info

• Ignore this comment if this PR does not change the documentation.
• It takes a few minutes for the preview to be available.
• The preview is updated when a new commit is pushed to this PR.
• This comment was created by https://github.com/mlflow/mlflow/actions/runs/6861129156.

[harupy]

@serena-ruan Did you use a formatter? looks like you did.

[serena-ruan]

@serena-ruan Did you use a formatter? looks like you did.

I used a script 🤣 Pattern matching and update

[harupy]

@serena-ruan mind sharing the script code here?

[serena-ruan]

@serena-ruan mind sharing the script code here?

import os
import re

def update_code_blocks(content):
    groups = re.findall(r"(.. code-section::\n.*.. code-block)", content)
    for group in groups:
        content = content.replace(group, "\n\n".join(group.split("\n")))
    return content

def update_tags(content):
    # Close <img> tags if it's not
    groups = re.findall(r"(<img(.*?)>)", content, flags=re.DOTALL)
    for group in groups:
        if group[1][-1] != "/":
            content = content.replace(group[0], "<img" + group[1] + "/>")
    # close <br> tags if it's not
    while match:=re.search(r'<br[^/]*?>', content):
        i, j = match.span()
        content = content[:i] + match.group()[:-1] + "/>" + content[j:]
    return content

def fix_code_blocks(folder):
    # Get a list of all files in the input folder and its subfolders
    for root, dirs, files in os.walk(folder):
        for file in files:
            if file.endswith('.rst'):
                rst_path = os.path.join(root, file)

                with open(rst_path, 'r') as f:
                    rst_content = f.read()

                rst_content = update_code_blocks(rst_content)
                rst_content = update_tags(rst_content)
                with open(rst_path, 'w') as f:
                    f.write(rst_content)

if __name__ == "__main__":
    folder = 'docs/source'

    fix_code_blocks(folder)

It has some mismatching cases so I manually checked the result

[BenWilson2]

LGTM! Thanks for the cleanup :)