Skip to content

Commit d352a35

Browse files
Add offline documentation building instructions
Added instructions for building documentation for offline use, including version references for Python, mkdocs, and uv.
1 parent 93515c2 commit d352a35

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,30 @@ For a general introduction to the BLAS routines, please refer to the extensive d
2424
<https://www.netlib.org/blas>. On that site you will likewise find documentation for the reference implementation of the higher-level library LAPACK - the **L**inear **A**lgebra **Pack**age that comes included with OpenBLAS. If you are looking for a general primer or refresher on Linear Algebra, the set of six
2525
20-minute lecture videos by Prof. Gilbert Strang on either MIT OpenCourseWare [here](https://ocw.mit.edu/resources/res-18-010-a-2020-vision-of-linear-algebra-spring-2020/) or YouTube [here](https://www.youtube.com/playlist?list=PLUl4u3cNGP61iQEFiWLE21EJCxwmWvvek) may be helpful.
2626

27+
## Building Documentation for offline use
28+
29+
You can run your own local instance of http://www.openmathlib.org/OpenBLAS/docs/ via:
30+
31+
```
32+
uv venv
33+
source .venv/bin/activate
34+
uv pip install mkdocs
35+
uv pip install $(mkdocs-get-deps)
36+
mkdocs serve
37+
```
38+
39+
For reference / reproducing in the future, here is a summary of the versions used:
40+
41+
```
42+
(OpenBLAS) yalihupokn@zoqu-endiman:~/Repositories/dc/OpenBLAS$ python --version
43+
Python 3.14.3
44+
(OpenBLAS) yalihupokn@zoqu-endiman:~/Repositories/dc/OpenBLAS$ mkdocs --version
45+
mkdocs, version 1.6.1 from /home/yalihupokn/Repositories/dc/OpenBLAS/.venv/lib64/python3.14/site-packages/mkdocs (Python 3.14)
46+
(OpenBLAS) yalihupokn@zoqu-endiman:~/Repositories/dc/OpenBLAS$ uv --version
47+
uv 0.11.2 (aarch64-unknown-linux-gnu)
48+
(OpenBLAS) yalihupokn@zoqu-endiman:~/Repositories/dc/OpenBLAS$
49+
```
50+
2751
## Binary Packages
2852

2953
We provide official binary packages for the following platform:

0 commit comments

Comments
 (0)