Stream: docs

Topic: building docs locally

Philip Durbin 🚀 (Aug 21 2025 at 13:27):

At the last docs meeting I volunteered to help anyone get docs to build locally, which is very useful for seeing how the HTML will look.

There are a number of dependencies so Docker might be the easiest. Once you have Docker installed, it should boil down to typing make docs-html like this: https://guides.dataverse.org/en/6.7.1/contributor/documentation.html#building-the-guides-with-a-sphinx-docker-container-and-a-makefile

Philip Durbin 🚀 (Sep 26 2025 at 15:03):

At the meeting just now, we recorded a video of building the docs locally.

We followed the steps in #11831 (and some more that I'll add). Here's the HTML version: https://dataverse-guide--11831.org.readthedocs.build/en/11831/contributor/documentation.html

Last updated: Nov 01 2025 at 14:11 UTC