← Back to issue list

Insufficient documentation on how to build Rockcraft's documentation

View original Github issue

Metadata

Project
rockcraft
Number
#627
Type
issue
State
open
Author
hd9
Labels
Created
2024-07-05 01:14:47+00:00
Updated
2026-03-17 16:15:31+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

### Request type Fix ### What needs to get done It's currently not possible to build Rockcraft's docs website [as described here](https://documentation.ubuntu.com/rockcraft/en/latest/tutorials/node-app/). The reason is, the article makes assumptions that a contributor understands how to get the environment setup. Here's what one would get when running `make installdocs` from the `docs` folder: ``` $ make installdocs . env/bin/activate; sphinx-build -M installdocs "." "_build" -q /bin/sh: 1: .: cannot open env/bin/activate: No such file make: *** [Makefile:49: installdocs] Error 2 ``` Would be nice to have clear instructions on how to build the docs in a fresh environment. For example: - Repo to clone - Any particular branch to use? - Which tools are required to build successfully? What needs to be installed? How? - Where should the `make installdocs` command be run from? In time, why not add a section to this page detailing how to propose your changes in a PR? Thanks! ### Documentation location https://documentation.ubuntu.com/rockcraft/en/latest/how-to/documentation/build-docs/ ### Additional information _No response_

Evaluation history

No evaluation history available.