Backed out changeset 7b2d241f1bc9 (bug 1817940) Backed out changeset aa4db2b5c160 (bug 1773847) Backed out changeset bcbb3d36cfac (bug 1773847) Backed out changeset 7617c68fd82c (bug 1806263) Backed out changeset 14ac016e4a35 (bug 1817390) Backed out changeset 32139f2c95b5 (bug 1816819) Backed out changeset 9b6f76032150 (bug 1817501) Backed out changeset 97b2aac909e0 (bug 1817529) Backed out changeset 5bfc78e7fd3c (bug 1817567) Backed out changeset 59ad2626f763 (bug 1817567) Backed out changeset 0d7897dc25f8 (bug 1817411) Backed out changeset ef279c093d3c (bug |
||
|---|---|---|
| .. | ||
| admin | ||
| assets | ||
| reviewing-tests | ||
| running-tests | ||
| writing-tests | ||
| .gitignore | ||
| .ruby-version | ||
| __init__.py | ||
| commands.json | ||
| conf.py | ||
| Dockerfile | ||
| frontend.py | ||
| index.md | ||
| intro-video-transcript.md | ||
| META.yml | ||
| package.json | ||
| 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.