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

Publish the CSS support list during doc builds #10196

Closed
larsbergstrom opened this issue Mar 25, 2016 · 6 comments
Closed

Publish the CSS support list during doc builds #10196

larsbergstrom opened this issue Mar 25, 2016 · 6 comments

Comments

@larsbergstrom
Copy link
Contributor

@larsbergstrom larsbergstrom commented Mar 25, 2016

In #9333, a script was added that prints out all of the properties support by Servo as JSON. In this project, we would edit the file https://github.com/servo/servo/blob/master/etc/ci/upload_docs.sh to run that script (via python components/style/list_properties.py) and store the output as a JSON file in the documentation tree so that it is uploaded after each build lands in master.

For extra brownie bonus points, adding a HTML file with some nice CSS styles to display that list to the https://github.com/servo/servo/tree/master/etc/doc.servo.org directory would be a really nice bonus! We could then link to that directly from servo.org.

This would fully close #3954.

@larsbergstrom
Copy link
Contributor Author

@larsbergstrom larsbergstrom commented Mar 25, 2016

@jrasanen
Copy link
Contributor

@jrasanen jrasanen commented Mar 26, 2016

@larsbergstrom so:

  1. Save the JSON of supported properties to ./target/doc/servo/ in upload_docs.sh
  2. Create ./etc/doc.servo.org/properties.html which reads the json file and outputs supported properties nicely

I could do this one.

@larsbergstrom
Copy link
Contributor Author

@larsbergstrom larsbergstrom commented Mar 26, 2016

@jrasanen That sounds like a great plan! Please let us know here if you have any questions :-)

@SimonSapin
Copy link
Member

@SimonSapin SimonSapin commented Mar 26, 2016

It’s also possible to generate static HTML at the same time as we generate JSON. There’s even a templating system (Mako) originally designed to generate HTML already being used in the relevant script.

@jrasanen
Copy link
Contributor

@jrasanen jrasanen commented Mar 26, 2016

@SimonSapin thanks, noted! I've used Mako before so will look into that.

@jrasanen
Copy link
Contributor

@jrasanen jrasanen commented Mar 26, 2016

Added a PR. Ping @larsbergstrom & @SimonSapin

bors-servo added a commit that referenced this issue Mar 28, 2016
Generate html and json of supported css properties.

Fixes #10196. Outputs html and json of supported css properties to `target/doc/` directory when deploying github-pages.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10208)
<!-- Reviewable:end -->
bors-servo added a commit that referenced this issue Mar 28, 2016
Generate html and json of supported css properties.

Fixes #10196. Outputs html and json of supported css properties to `target/doc/` directory when deploying github-pages.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10208)
<!-- Reviewable:end -->
bors-servo added a commit that referenced this issue Mar 29, 2016
Generate html and json of supported css properties.

Fixes #10196. Outputs html and json of supported css properties to `target/doc/` directory when deploying github-pages.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10208)
<!-- Reviewable:end -->
bors-servo added a commit that referenced this issue Mar 29, 2016
Generate html and json of supported css properties.

Fixes #10196. Outputs html and json of supported css properties to `target/doc/` directory when deploying github-pages.

<!-- Reviewable:start -->
---
This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10208)
<!-- Reviewable:end -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.