corysanin/tubestation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d48bff0b3e786cb15c63caa06c0e2380ad84c0ab
tubestation/testing/web-platform/tests/docs/README.md
jugglinmike f20acee66f Bug 1560902 [wpt PR 17401] - [docs] Increase strictness of build process, a=testonly 
Automatic update from web-platform-tests
[docs] Increase strictness of build process (#17401)

Use the `-W` flag to interpret Sphinx warnings as errors, causing the
build to fail in the presence of either. This makes various authoring
mistakes more visible. Perhaps most importantly: it highlights instances
of "orphaned" content.

Fix all details which were previously reported as warnings and thus
permitted.
--

wpt-commits: 9c6304b71c5ee090ebc1eef02ab32b70444d9704
wpt-pr: 17401
2019-07-24 13:30:35 +01:00

1.1 KiB
Raw Blame History

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.