diff --git a/README.md b/README.md index 314bc007f379..c62b07ebd6c5 100644 --- a/README.md +++ b/README.md @@ -417,9 +417,11 @@ readthedocs theme. ```bash cd docs/ pip install -r requirements.txt +make html +make serve ``` -You can then build the documentation by running `make ` from the -`docs/` folder. Run `make` to get a list of all available output formats. + +Run `make` to get a list of all available output formats. If you get a katex error run `npm install katex`. If it persists, try `npm install -g katex` diff --git a/docs/Makefile b/docs/Makefile index c6df057d8a6a..36e428cf4de9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -41,7 +41,10 @@ html-stable: # See conf.py for more details. RELEASE=1 make html -.PHONY: help Makefile docset onnx exportdb +.PHONY: help Makefile docset onnx exportdb serve + +serve: + @cd $(BUILDDIR)/html && $(PYCMD) -m http.server $(PORT) # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).