Skip to content

docs: added windows specfic intructions for building documentation - #1583

Open
Troppy2 wants to merge 1 commit into
pyproj4:mainfrom
Troppy2:docs/windows-build-instructions
Open

docs: added windows specfic intructions for building documentation#1583
Troppy2 wants to merge 1 commit into
pyproj4:mainfrom
Troppy2:docs/windows-build-instructions

Conversation

@Troppy2

@Troppy2 Troppy2 commented Mar 14, 2026

Copy link
Copy Markdown

Fixes #1491

Added Windows-specific instructions for building documentation:

  • Note to use make html instead of make docs
  • Clarify that requirements-docs.txt needs to be installed

This helps Windows users who may not be familiar with the Unix make commands.

Comment thread CONTRIBUTING.md
* Build the docs: ``make docs``
* Or, to build and open in a browser: ``make docs-browser``

**On Windows:** Use ``make html`` instead of ``make docs``. Also ensure you have installed the documentation requirements with ``pip install -r requirements-docs.txt`` before building.

@snowman2 snowman2 Jul 25, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**On Windows:** Use ``make html`` instead of ``make docs``. Also ensure you have installed the documentation requirements with ``pip install -r requirements-docs.txt`` before building.
**On Windows:** Use ``make -C docs html`` instead of ``make docs``. Also ensure you have installed the documentation requirements with ``pip install --group docs`` before building.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: add help for building the docs in windows

2 participants