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

Add dashing config file for generating docset from flutter docs #24374

Merged
merged 1 commit into from Nov 15, 2018

Conversation

imWildCat
Copy link
Contributor

@imWildCat imWildCat commented Nov 15, 2018

The aim of this PR is to introduce .docset for Flutter APIs in relation to #9955.

A brief description about building this docset:

Prerequisites

  1. A clone of the Flutter repository
  2. Installed technosophos/dashing

Docset building procedure

  1. Run the script dev/bots/docs.sh to build Flutter docs.
  2. Execute dashing build --source ./doc --config dashing.json to build the docset.

Issues of this configuration file

  1. There is no configuration field for the version number in the requirements of dashing.json. The version number could be specified at a 'Dash documentation feeds' file. For more details, please read: https://kapeli.com/docsets#dashdocsetfeed. In addition, here is my minimal example: https://github.com/imWildCat/flutter-docset/blob/master/flutter.xml.

  2. As for icon32x32 in dashing.json, dev/docs/doc/flutter/static-assets/favicon.png is used currently. This icon image works well in the Dash.app though this image is actually '64x64'.

  3. The selectors of different entry types should be improved for better doc navigation.

References

  1. Supported Entry Types - Docset Generation Guide: https://kapeli.com/docsets#supportedentrytypes
  2. technosophos/dashing: A Dash Generator Script for Any HTML: https://github.com/technosophos/dashing

@gspencergoog
Copy link
Contributor

Thanks so much!
32384589-a60f0e74-c078-11e7-9bc1-e5b5287aea9d

@gspencergoog gspencergoog merged commit ec8ca86 into flutter:master Nov 15, 2018
jonahwilliams added a commit that referenced this pull request Nov 15, 2018
jonahwilliams added a commit that referenced this pull request Nov 15, 2018
* Revert "Add dashing config file for generating docset from flutter docs (#24374)"

This reverts commit ec8ca86.

* Revert "Update driver script to execute test through test_core (#24168)"

This reverts commit 6c62cf3.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants