Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ Quick links
* [Running the test suite](https://docs.pymc.io/en/latest/contributing/running_the_test_suite.html)
* [Running PyMC in Docker](https://docs.pymc.io/en/latest/contributing/docker_container.html)
* [Submitting a bug report or feature request](https://github.com/pymc-devs/pymc/issues)

For a complete list visit [the contributing section of the documentation](https://docs.pymc.io/en/latest/contributing/index.html).
9 changes: 7 additions & 2 deletions docs/source/contributing/build_docs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Build documentation locally

To build the docs, run these commands at pymc repository root:
:::{warning}
Docs build is not supported on Windows.
To build docs on Windows we recommend running inside a Docker container.
:::

To build the docs, run these commands at PyMC repository root:

```bash
$ pip install -r requirements-dev.txt # Make sure the dev requirements are installed
Expand All @@ -9,7 +14,7 @@ $ make html # Build docs
$ python -m http.server --directory docs/_build/ # Render docs
```

Check the printed url where docs are being served and open it.
Check the printed URL where docs are being served and open it.

The `make clean` step is not always necessary, if you are working on a specific page
for example, you can rebuild the docs without the clean step and everything should
Expand Down
263 changes: 0 additions & 263 deletions make.bat

This file was deleted.