Skip to content

docs: added windows specfic intructions for building documentation #1583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Troppy2 wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −0
Open

docs: added windows specfic intructions for building documentation #1583

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ You can build the documentation locally to see how your changes will look.
* 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.

## Tests
Unit tests are the lifeblood of the project, as it ensures that we can continue to add and
change the code and stay confident that things have not broken. Running the tests requires
Expand Down