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

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.

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.
@wpt-pr-bot wpt-pr-bot added docs infra wptrunner The automated test runner, commonly called through ./wpt run labels Oct 11, 2019
@foolip
Copy link
Member

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
Copy link
Contributor Author

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
Copy link
Contributor Author

@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs infra wptrunner The automated test runner, commonly called through ./wpt run
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants