Skip to content

DOC: developer docs for building documentation #3354

@K-Meech

Description

@K-Meech

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 guess make isn't available by default?
  • hatch --env docs run serve worked, but following the http://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 as make 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 to http://localhost:8000/? This worked on my system, and should hopefully work for mac / linux too.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements to the documentationhelp wantedIssue could use help from someone with familiarity on the topic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions