Skip to content

Commit 73a5957

Browse files
Update docs build and contributing instructions (#5938)
* Simplify outdated docs build script * Remove Windows docs build script It was completely outdated. Also, building docs on Windows currently fails because `pm.sampling_jax` can't be imported. * Link to contributing page in the docs Closes #5843
1 parent f617180 commit 73a5957

File tree

3 files changed

+9
-265
lines changed

3 files changed

+9
-265
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ Quick links
1111
* [Running the test suite](https://docs.pymc.io/en/latest/contributing/running_the_test_suite.html)
1212
* [Running PyMC in Docker](https://docs.pymc.io/en/latest/contributing/docker_container.html)
1313
* [Submitting a bug report or feature request](https://github.com/pymc-devs/pymc/issues)
14+
15+
For a complete list visit [the contributing section of the documentation](https://docs.pymc.io/en/latest/contributing/index.html).

docs/source/contributing/build_docs.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Build documentation locally
22

3-
To build the docs, run these commands at pymc repository root:
3+
:::{warning}
4+
Docs build is not supported on Windows.
5+
To build docs on Windows we recommend running inside a Docker container.
6+
:::
7+
8+
To build the docs, run these commands at PyMC repository root:
49

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

12-
Check the printed url where docs are being served and open it.
17+
Check the printed URL where docs are being served and open it.
1318

1419
The `make clean` step is not always necessary, if you are working on a specific page
1520
for example, you can rebuild the docs without the clean step and everything should

make.bat

Lines changed: 0 additions & 263 deletions
This file was deleted.

0 commit comments

Comments
 (0)