File tree Expand file tree Collapse file tree 4 files changed +30
-4
lines changed Expand file tree Collapse file tree 4 files changed +30
-4
lines changed Original file line number Diff line number Diff line change @@ -43,6 +43,8 @@ Coding guidelines
4343 provided in tutorial format and/or in module docstrings. A guide on how to
4444 write documentation is given in the `numpydoc docstring guide `_.
4545
46+ Looking for `how to build the docs `_?
47+
46483. Code style
4749 Uniformity of style in which code is written is important to others trying
4850 to understand the code. PyWavelets follows the standard Python guidelines
@@ -64,3 +66,5 @@ Coding guidelines
6466.. _pyflakes : http://pypi.python.org/pypi/pyflakes
6567
6668.. _testing guidelines : https://github.com/numpy/numpy/blob/main/doc/TESTS.rst.txt
69+
70+ .. _how to build the docs : ./doc/source/dev/how_to_build_the_docs.rst
Original file line number Diff line number Diff line change @@ -20,10 +20,6 @@ To verify the installation run the following command::
2020
2121 pytest .
2222
23- To build docs::
24-
25- cd doc
26- make html
2723
2824Installing a development version
2925--------------------------------
Original file line number Diff line number Diff line change 1+ .. _dev-building-docs :
2+
3+ How to build the docs locally
4+ =============================
5+
6+ After preparing your Windows or Linux environment, install Spin and Ninja::
7+
8+ pip install spin ninja
9+
10+ Then install the documentation-related dependencies::
11+
12+ pip install -r util/readthedocs/requirements.txt
13+
14+ Then tell Spin to build the Sphinx documentation::
15+
16+ spin docs
17+
18+ Then open a webserver to serve the built HTML files::
19+
20+ python -m http.server -d doc/build/html 8000
21+
22+ And open your local docs in a web browser by visiting http://localhost:8000/.
23+
24+ If it's your first time building the docs, it will take a while but should go
25+ faster on subsequent re-builds.
Original file line number Diff line number Diff line change @@ -17,6 +17,7 @@ on Windows and Linux.
1717 installing_build_dependencies
1818 building_extension
1919 testing
20+ how_to_build_the_docs
2021 how_to_release
2122
2223Something not working?
You can’t perform that action at this time.
0 commit comments