Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Include wptrunner docs on web-platform-tests.org #19647

Merged
merged 7 commits into from Oct 14, 2019

Conversation

@jugglinmike
Copy link
Contributor

jugglinmike commented Oct 11, 2019

The wptrunner module has a substantial amount of documentation describing its usage and internals. It was authored to be built as a standalone web site using a prior release of the Sphinx documentation generator.

Update the structure of the existing wptrunner documentation so that it may be built in the context of the WPT documentation website. Extend the existing documentation with two references to the new content: one in the "Tooling" section of the "Project Administration" page, and one in the instructions on running the tests from the command line. Remove the code used to generate a standalone website for wptrunner.

jugglinmike added 7 commits Oct 11, 2019
These classes are referenced from the ReStructuredText-formatted
documentation.
The Mozilla-provided "intersphinx" metadata does not include an entry
for the "mozlog" module. Replace the rST cross-referencing roles with a
hyperlink to the documentation webpage.
@foolip

This comment has been minimized.

Copy link
Contributor

foolip commented Oct 11, 2019

Is there a way to see a preview of what this will look like?

Relayed, I know the "documentation / build-and-publish" check isn't doing staging, but it prints "No files related to the website have been modified" which seems suspect, do the rules for what can affect the docs need to be updated?

@jugglinmike

This comment has been minimized.

Copy link
Contributor Author

jugglinmike commented Oct 11, 2019

Is there a way to see a preview of what this will look like?

I pushed the built assets to Bocoup's fork of WPT:

https://bocoup.github.io/wpt/

Relayed, I know the "documentation / build-and-publish" check isn't doing staging, but it prints "No files related to the website have been modified" which seems suspect, do the rules for what can affect the docs need to be updated?

I'm looking in to that now

@jugglinmike

This comment has been minimized.

Copy link
Contributor Author

jugglinmike commented Oct 11, 2019

@foolip it looks like we missed something when we enabled this Action for Pull Requests in gh-19303. I've submitted a fix for that here: gh-19650.

To diagnose this, I used a Draft Pull Request based on this one. That means it also demonstrates the patch can be built without error in the GitHub Actions environment: gh-19648

@jgraham jgraham merged commit 6ffed67 into web-platform-tests:master Oct 14, 2019
19 checks passed
19 checks passed
build-and-publish
Details
build-and-tag
Details
Azure Pipelines Build #20191011.134 succeeded
Details
Azure Pipelines (./wpt test-jobs) ./wpt test-jobs succeeded
Details
Azure Pipelines (affected tests without changes: Safari Technology Preview) affected tests without changes: Safari Technology Preview succeeded
Details
Azure Pipelines (affected tests: Safari Technology Preview) affected tests: Safari Technology Preview succeeded
Details
Azure Pipelines (infrastructure/ tests: macOS) infrastructure/ tests: macOS succeeded
Details
Azure Pipelines (tools/ unittests: Windows Python 3) tools/ unittests: Windows Python 3 succeeded
Details
Azure Pipelines (tools/ unittests: Windows) tools/ unittests: Windows succeeded
Details
Azure Pipelines (tools/ unittests: macOS) tools/ unittests: macOS succeeded
Details
Azure Pipelines (tools/wpt/ tests: Windows) tools/wpt/ tests: Windows succeeded
Details
Azure Pipelines (tools/wpt/ tests: macOS) tools/wpt/ tests: macOS succeeded
Details
Azure Pipelines (tools/wptrunner/ unittests: Windows) tools/wptrunner/ unittests: Windows succeeded
Details
Azure Pipelines (tools/wptrunner/ unittests: macOS) tools/wptrunner/ unittests: macOS succeeded
Details
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests) wpt.fyi hook: safari-preview-affected-tests succeeded
Details
Azure Pipelines (wpt.fyi hook: safari-preview-affected-tests-without-changes) wpt.fyi hook: safari-preview-affected-tests-without-changes succeeded
Details
Taskcluster (pull_request) TaskGroup: success
Details
staging.wpt.fyi - safari[experimental] Safari results
Details
wpt.fyi - safari[experimental] Safari results
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.