diff mupdf-source/docs/README @ 3:2c135c81b16c

MERGE: upstream PyMuPDF 1.26.4 with MuPDF 1.26.7
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:44:09 +0200
parents b50eed0cc0ef
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/docs/README	Mon Sep 15 11:44:09 2025 +0200
@@ -0,0 +1,48 @@
+# Building MuPDF Documentation
+
+This documentation relies on
+[Sphinx](https://www.sphinx-doc.org/en/master/)
+to publish HTML docs from source files written with
+[reStructuredText](https://docutils.sourceforge.io/rst.html)
+and [Markdown](https://myst-parser.readthedocs.io/en/latest/intro.html).
+
+## Installing Sphinx
+
+This README assumes you have [installed Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html) on your system.
+
+We recommend setting up a virtual environment:
+
+	python -m venv .venv
+
+Activate the environment by sourcing the activation script:
+
+	source .venv/bin/activate
+
+In this environment run pip to install Sphinx and all the required modules.
+
+	pip install -r docs/requirements.txt
+
+## Building HTML documentation
+
+Within the virtual environment you can now build the documentation:
+
+	sphinx-build docs build/docs
+
+To do a fresh rebuild (in case files in the `_static` folder or the toc structure has changed):
+
+	sphinx-build -E -a docs build/docs
+
+## Live edit HTML documentation
+
+You can use [Sphinx Autobuild](https://pypi.org/project/sphinx-autobuild/) to rebuild
+the documentation on changes, with hot reloading in the browser.
+
+	pip install sphinx-autobuild
+	sphinx-autobuild --open-browser docs build/docs
+
+## Using the Makefile targets
+
+We also have makefile targets and helper scripts to perform the above tasks:
+
+	make docs
+	make docs-live