Backed out changeset 7baa72e0d62c (bug 1637486) Backed out changeset 24e38d0cf349 (bug 1635702) Backed out changeset a99469886218 (bug 1635702) Backed out changeset 0bd06c295951 (bug 1637211) Backed out changeset 893f40e8ac70 (bug 1637211) Backed out changeset 7e4449460eee (bug 1636952) Backed out changeset abc7724f7d24 (bug |
||
|---|---|---|
| .. | ||
| admin | ||
| assets | ||
| reviewing-tests | ||
| running-tests | ||
| writing-tests | ||
| .gitignore | ||
| .ruby-version | ||
| __init__.py | ||
| conf.py | ||
| index.md | ||
| intro-video-transcript.md | ||
| make.bat | ||
| Makefile | ||
| META.yml | ||
| README.md | ||
| requirements.txt | ||
| test-suite-design.md | ||
| wpt_lint_rules.py | ||
Project documentation tooling
The documentation for the web-platform-tests project is built using the Sphinx documentation generator. The GitHub Actions service 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.
-
Install the system dependencies. The free and open source software tools Python and Git are required. Each website has instructions for downloading and installing on a variety of systems.
-
Download the source code. Clone this repository using the
git clonecommand. -
Install the Python dependencies. Run the following command in a terminal from the "docs" directory of the WPT repository:
pip install -r requirements.txt -
Build the documentation. Windows users should execute the
make.batbatch file. GNU/Linux and macOS users should use themakecommand.