-
-
Notifications
You must be signed in to change notification settings - Fork 356
Open
Labels
documentationImprovements to the documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topicIssue could use help from someone with familiarity on the topic
Description
Describe the issue linked to the documentation
Following the instructions in the contributing guide, I failed to build the documentation locally.
hatch --env docs run build
errored with:'make' is not recognized as an internal or external command
. I'm on a Windows computer, so I guessmake
isn't available by default?hatch --env docs run serve
worked, but following thehttp://0.0.0.0:8000/
link returned 'This site can't be reached'
Suggested fix for documentation
- It would be good to mention that Windows users should prefer to use
hatch --env docs run serve
asmake
isn't available by default. (would be good if someone could verify this is the same for their windows setup + it's not just my computer!) - For
hatch --env docs run serve
, could the suggested link be changed tohttp://localhost:8000/
? This worked on my system, and should hopefully work for mac / linux too.
joshmoore
Metadata
Metadata
Assignees
Labels
documentationImprovements to the documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topicIssue could use help from someone with familiarity on the topic