diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 19:33:14 +0000 |
commit | 36d22d82aa202bb199967e9512281e9a53db42c9 (patch) | |
tree | 105e8c98ddea1c1e4784a60a5a6410fa416be2de /testing/web-platform/tests/docs/README.md | |
parent | Initial commit. (diff) | |
download | firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip |
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'testing/web-platform/tests/docs/README.md')
-rw-r--r-- | testing/web-platform/tests/docs/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/testing/web-platform/tests/docs/README.md b/testing/web-platform/tests/docs/README.md new file mode 100644 index 0000000000..a753462429 --- /dev/null +++ b/testing/web-platform/tests/docs/README.md @@ -0,0 +1,24 @@ +# Project documentation tooling + +The documentation for the web-platform-tests project is built using [the Sphinx +documentation generator](http://www.sphinx-doc.org). [The GitHub Actions +service](https://github.com/features/actions) is configured to automatically +update the public website each time changes are merged to the repository. + +## Local Development + +If you would like to build the site locally, follow these instructions. + +1. Install the system dependencies. The free and open source software tools + [Python](https://www.python.org/) and [Git](https://git-scm.com/) are + required. Each website has instructions for downloading and installing on a + variety of systems. +2. Download the source code. Clone this repository using the `git clone` + command. +3. Install the Python dependencies. Run the following command in a terminal + from the "docs" directory of the WPT repository: + + pip install -r requirements.txt + +4. Build the documentation. Windows users should execute the `make.bat` batch + file. GNU/Linux and macOS users should use the `make` command. |