servo/tests/wpt/web-platform-tests/docs
2023-04-30 01:30:40 +00:00
..
admin Update web-platform-tests to revision b'b728032f59a396243864b0f8584e7211e3632005' 2022-11-10 01:27:28 +00:00
assets Update web-platform-tests to revision 5e7cbed423a3040dc8ca50359dd033a46dba5cf4 2020-04-26 11:12:33 +00:00
reviewing-tests Update web-platform-tests to revision b'797e75946c24d0625f04247b16d33c26d4ada273' 2023-04-30 01:30:40 +00:00
running-tests Update web-platform-tests to revision b'065cf84e9f00d1c11faf2a41e500a73ad6b95a48' 2023-03-21 01:40:05 +00:00
writing-tests Update web-platform-tests to revision b'3ee7ccc2abbbc8d8f6efbb45f80bffdb3c0c76ba' 2023-03-11 01:46:58 +00:00
.gitignore Update web-platform-tests to revision 3cb5a99e5521936fb8819de8aaba806050b84184 2019-06-23 14:05:43 +00:00
.ruby-version Update web-platform-tests to revision 8a2ceb5f18911302b7a5c1cd2791f4ab50ad4326 2017-10-12 12:36:21 -04:00
__init__.py Update web-platform-tests to revision 89aa3f42131cce5a77268ddaeb2fab8a2e29c2a6 2019-11-17 14:10:26 +00:00
commands.json Update web-platform-tests to revision b'b728032f59a396243864b0f8584e7211e3632005' 2022-11-10 01:27:28 +00:00
conf.py Update web-platform-tests to revision b'ee6da9d71d0268d7fdb04e8e5b26858f46ee0cc4' 2022-01-20 20:57:54 +09:00
Dockerfile Update web-platform-tests to revision b'b728032f59a396243864b0f8584e7211e3632005' 2022-11-10 01:27:28 +00:00
frontend.py Update web-platform-tests to revision b'b728032f59a396243864b0f8584e7211e3632005' 2022-11-10 01:27:28 +00:00
index.md Update web-platform-tests to revision b'468d01bbd84da2babf265c6af46947be68713440' 2022-01-17 16:30:29 +09:00
intro-video-transcript.md Update web-platform-tests to revision 70fdd27f4cecb8a5cae3dafa76ba05265531c9e2 2019-11-10 14:14:47 +00:00
META.yml Update web-platform-tests to revision ac16628eb7eb601957382053011363d2bcf8ce44 2020-02-17 11:33:33 +00:00
package.json Update web-platform-tests to revision b'ee6da9d71d0268d7fdb04e8e5b26858f46ee0cc4' 2022-01-20 20:57:54 +09:00
README.md Update web-platform-tests to revision 3cb5a99e5521936fb8819de8aaba806050b84184 2019-06-23 14:05:43 +00:00
requirements.txt Update web-platform-tests to revision b'2703c75d5e889bb7c6a918de44841bf9de8d63a7' 2023-03-25 01:54:46 +00:00
test-suite-design.md Update web-platform-tests to revision 716f0ac8e3e016318c301828428ce241a1dd0e08 2019-09-05 14:27:37 +00:00
wpt_lint_rules.py Update web-platform-tests to revision b'468d01bbd84da2babf265c6af46947be68713440' 2022-01-17 16:30:29 +09:00

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.

  1. 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.

  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.