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

DOC-3247 Fix documentation in main branch: increase toctree maxdepth to 3 #2007

Merged
merged 2 commits into from
Jul 31, 2024

Conversation

sfc-gh-mbartolome
Copy link
Contributor

@sfc-gh-mbartolome sfc-gh-mbartolome commented Jul 30, 2024

  1. Which Jira issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

    Fixes DOC-3247 which is related to SNOW-1453518

  2. Fill out the following pre-review checklist:

    • I am adding a new automated test(s) to verify correctness of my new code
      • If this test skips Local Testing mode, I'm requesting review from @snowflakedb/local-testing
    • I am adding new logging messages
    • I am adding a new telemetry message
    • I am adding new credentials
    • I am adding a new dependency
    • If this is a new feature/behavior, I'm adding the Local Testing parity changes.
  3. Please describe how your code solves the related issue.

    This same fix was made in SNOW-1453518 Fix documentation for v1.17.0 - increase toctree maxdepth to 3 #1708 and SNOW-1453518 Fix documentation in v1.18.0 #1711 for the v1.17.0 and v1.18.0 branches, but not yet in main so the sidebar navigation issue was reintroduced again in the 1.19.0 release.

    Refer to thread: https://snowflake.slack.com/archives/C049VF99031/p1717087196127959?thread_ts=1716580744.074129&cid=C049VF99031

    • Increased the toctree maxdepth from 2 to 3 - this should make the sidebar navigation work as expected (drop downs).
    • Removed duplicate session documentation link for index.rst for Snowpark APIs - it should still exist in the landing page.

@sfc-gh-mbartolome sfc-gh-mbartolome added documentation Improvements or additions to documentation NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md labels Jul 30, 2024
@sfc-gh-mbartolome sfc-gh-mbartolome requested a review from a team as a code owner July 30, 2024 23:43
Copy link

github-actions bot commented Jul 30, 2024

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@sfc-gh-mbartolome
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@sfc-gh-mbartolome
Copy link
Contributor Author

@sfc-gh-vbudati @sfc-gh-jrose thanks for the review!

Looks like I don't have access to merge into main in this repo – would one of you mind merging it for me?

@sfc-gh-jrose sfc-gh-jrose merged commit 57b315c into main Jul 31, 2024
36 checks passed
@sfc-gh-jrose sfc-gh-jrose deleted the mbartolome-DOC-3247-toctree-doc-fixes-main-branch branch July 31, 2024 15:57
@github-actions github-actions bot locked and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation NO-CHANGELOG-UPDATES This pull request does not need to update CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants