update documentation generation guidelines#2519
update documentation generation guidelines#2519adit-0132 wants to merge 1 commit intoarviz-devs:mainfrom
Conversation
|
@adit-0132 thanks for reporting, we'll open a PR to fix this very soon. The recommended way is to use You'll probably have seen this in the PR template already but note that most work on ArviZ features will not happen in this repository but instead on |
|
@OriolAbril got it, thanks for letting me know. |
|
#2522 updates the PR step by step tutorial. Here is the doc preview from that PR: https://arviz--2522.org.readthedocs.build/en/2522/contributing/pr_tutorial.html. Don't hesitate to comment on the PR if there are still things that aren't clear or don't work Note: the I will close the PR but again, thanks for reporting the issues and opening the PR even if we eventually did not use these changes. |
fixes #2518
This PR updates the local documentation build instructions to match the current
repository layout.
The docs previously described a Makefile-based workflow (
make html,make livehtml,make cleandocs), but the repository does not include aMakefile and the docs are built by invoking Sphinx directly.
The instructions are updated to use
sphinx-buildandsphinx-autobuild,while preserving the existing structure and intent of the guide.