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

Misleading message after doc generation #819

Closed
polux opened this issue Aug 17, 2015 · 3 comments
Closed

Misleading message after doc generation #819

polux opened this issue Aug 17, 2015 · 3 comments
Assignees
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Milestone

Comments

@polux
Copy link
Contributor

polux commented Aug 17, 2015

When you're done generating the doc, dartdoc writes:

Success! Open file:///.../doc/api/index.html

But when you do this the search box is unavailable because the browser refuses to load the JSON index file. Maybe the message should mention this somehow. Maybe it could say something like "run python -m SimpleHttpClient in .../doc/ and point you browser to http://localhost:8000/api", which would work for most users. Or there could be dartdoc serve command.

@sethladd sethladd added type-enhancement A request for a change that isn't a bug P2 A bug or feature request we're likely to work on labels Aug 17, 2015
@sethladd
Copy link
Contributor

Thanks! We should fix this. Patches welcome :)

We could embed a small web server into dartdoc. Maybe https://github.com/sethladd/simple_http_server ? (not sure how embeddable it is)

@sethladd sethladd added the contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) label Aug 17, 2015
@polux polux closed this as completed Aug 18, 2015
@polux polux reopened this Aug 18, 2015
@polux
Copy link
Contributor Author

polux commented Aug 18, 2015

Opps, sorry for closing the issue by mistake, reopened.

Instead of embedding we could just tell users to run any server if they want to use the search box, and give a commandline example using simple_http_server.

@sethladd
Copy link
Contributor

See also #854

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributions-welcome Contributions welcome to help resolve this (the resolution is expected to be clear from the issue) P2 A bug or feature request we're likely to work on type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

2 participants