docs: add CmdStanPy getting-started example

[patelshivani2283-lab]

This PR addresses feedback from the JOSS review regarding discoverability
of CmdStanPy support.

Changes:

• Add a minimal CmdStanPy → ArviZ example to the getting started page
• Link to the CmdStanPy conversion guide for further details

This should make it clearer to new users how to use ArviZ with CmdStanPy
without needing to search the API reference.

[read-the-docs-community]

Documentation build overview

📚 arviz-base | 🛠️ Build #31396801 | 📁 Comparing 3ad49a5 against latest (ca9a28f)

🔍 Preview build

Show files changed (25 files in total): 📝 23 modified | ➕ 1 added | ➖ 1 deleted

File	Status
index.html	📝 modified
api/index.html	📝 modified
contributing/updating_example_data.html	➖ deleted
how_to/ConversionGuideCmdStanPy.html	➕ added
how_to/ConversionGuideEmcee.html	📝 modified
how_to/ConversionGuideNumPyro.html	📝 modified
tutorial/WorkingWithDataTree.html	📝 modified
tutorial/label_guide.html	📝 modified
api/generated/arviz_base.convert_to_dataset.html	📝 modified
api/generated/arviz_base.convert_to_datatree.html	📝 modified
api/generated/arviz_base.dataset_to_dataarray.html	📝 modified
api/generated/arviz_base.dataset_to_dataframe.html	📝 modified
api/generated/arviz_base.dict_to_dataset.html	📝 modified
api/generated/arviz_base.explode_dataset_dims.html	📝 modified
api/generated/arviz_base.extract.html	📝 modified
api/generated/arviz_base.from_cmdstanpy.html	📝 modified
api/generated/arviz_base.from_dict.html	📝 modified
api/generated/arviz_base.from_emcee.html	📝 modified
api/generated/arviz_base.from_numpyro.html	📝 modified
api/generated/arviz_base.load_arviz_data.html	📝 modified
api/generated/arviz_base.ndarray_to_dataarray.html	📝 modified
api/generated/arviz_base.rc_context.html	📝 modified
api/generated/arviz_base.references_to_dataset.html	📝 modified
api/generated/arviz_base.xarray_sel_iter.html	📝 modified
api/generated/arviz_base.xarray_var_iter.html	📝 modified

[patelshivani2283-lab]

Hi!
This PR addresses JOSS feedback on CmdStanPy discoverability.
Happy to make any adjustments if needed. Thanks!

[aloctavodia]

To check the results of your changes you can render the docs locally and/or click here to get a preview of the documentation.

[OriolAbril]

Link to the CmdStanPy conversion guide for further details

This page doesn't exist and should be added so it shows on the sidebar. If you look at the preview you can see the sidebar has not been updated because the page you are trying to add to it doesn't exist.

From the discussion on the issue, I'd say the fact cmdstanpy didn't have a dedicated page but the other PPLs did was the main problem so I would focus on that instead of adding an example on the landing page (which will probably need some updates but they need more discussion before we decide/agree what those changes should be).

[patelshivani2283-lab]

Added the CmdStanPy conversion notebook as discussed.
Please let me know if any changes are needed.

[aloctavodia]

Hi @patelshivani2283-lab, you have not added any changes since the review, maybe you forgot to push?

[patelshivani2283-lab]

All changes here are documentation-only.
CI failures are unrelated and should not block the PR.

[patelshivani2283-lab]

Hi, I have applied the requested changes:

• Moved the CmdStanPy example to a dedicated guide
• Updated sidebar ordering
• Applied formatting fixes

Please let me know if anything else is needed from my side. Thank you!

[aloctavodia]

reverse

[patelshivani2283-lab]

Hi Sir,
I have applied all requested changes:

Moved the CmdStanPy example to its dedicated guide

Updated the sidebar/tutorial ordering alphabetically

Fixed formatting issues and unintended changes

Updated WorkingWithDataTree notebook as needed

Please let me know if anything else is needed. Thank you!

[aloctavodia]

please double-check docs/source/index.md

[patelshivani2283-lab]

Hi @OriolAbril,
I have fixed the tutorial ordering in docs/source/index.md and pushed the update.

I also see that the external tests are failing — please let me know if this is related to my changes or if anything else is needed from my side.

Thank you!

[OriolAbril]

I have gone over the previous comments and marked most of them as "resolved". I strongly recommend you do this yourself to keep track of what has been addressed and what hasn't. You removed the workingwithdatatree page from the sidebar which is a huge blocker for merging the PR and was pointed out by @aloctavodia already yet it is still deleted.

This is general advise, not specific to this round of review, but it could have helped with the issue I mention above. It is also a good idea to review your own PR from the "Files changed" tab. There you can see

WorkingWithDataTree is removed and not added anywhere else. It should continue to be listed and it should continue to be the first element on the sidebar (my previous comment about ordering was about order of the 3 conversion guides, not about the sidebar as a whole, the label guide doesn't really matter but the datatree page should be the first).

---

You can also click on the ... and "View details" on the CI checks to take a look at the failure reasons, here is one example. If you look at that you can see that CI is indeed failing for reasons directly related to your changes. I think you will be able to fix this with tox -e check directly, but also note we have recently updated a few contributing pages so it might also be helpful to check the PR checklist and similar pages like the PR step-by-step page.

[OriolAbril]

It looks like you did not run nor check the linting and formatting rules. Please read my last comment again

[patelshivani2283-lab]

Hi @OriolAbril,
I’ve restored tutorial/WorkingWithDataTree to the Tutorials toctree and ensured it is listed as the first item in the sidebar.
I also ran tox -e check locally and applied all linting and formatting fixes.
Please let me know if anything else needs adjustment. Thank you for the guidance!