dartdoc command should not generates docs for dart-sdk #1949
Labels
customer-flutter
Issues originating from important to Flutter
P1
A high priority bug; for example, a single project is unusable or has many test failures
Comments
|
I think this is a bug related to flutter.. We have the same issue on dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui' |
|
This issue still exists in Dart v2.3.0 |
|
This issue still exists in flutter 1.9.8-pre.82 |
jcollins-g
added
P2
|
flutter 1.10.7, dart 2.6.0, dartdoc 0.28.6 |
jcollins-g
added
P1
|
And actually it's the oposite of what is described in the DartDoc 's readme. |
|
@mit-mit Sorry I was wrong, I'm on: On master I get from
Instead of just a rx_widget folder Attached is a console log |
|
@escamoteur not sure if you encountered some errors, but you have to include all the new packages in the list. $FLUTTER_ROOT/bin/cache/dart-sdk/bin/dartdoc --exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:ffi,dart:html,dart:io,dart:isolate,dart:js,dart:js_util,dart:math,dart:typed_data,dart:ui'Also remember to clean up everything in the folder first. |
|
@parsodyl oh I guess you are right. didn't consider that it's just more packets in the latest version. Still would be good if it would work without the need to do this |
|
@escamoteur yeah, I hope it will be fixed soon as well. |
|
I tried to add the exclude list identified by @parsodyl to dartdoc_options.yaml rather than the command, but it seems to be ignored... |
|
dartdoc_options.yaml is context specific. So conceptually if you had a library named 'dart:async' in your own package it would exclude that.... |
|
Can I ask why this is closed? The problem isn't solved how to make sure that dartdoc only documents the everything inside the current project and nothing more |
|
This was closed by mistake, apologies. |
|
Thanks @jcollins-g for the explanation about context, but I am still surprised to find that this works as expected... But a dartdoc_options.yaml file in my project folder with the same exclude does not work... |
|
@JncSol I have the same problem, did you find any workaround this? |
|
@JncSol and @tbarbugli: You cannot exclude sdk packages like In my project I took the opposite approach. Say I have the following libraries in my package, e.g. dartdoc:
include: ['common_components', 'left_menu_components', 'header_components']I find this option better because, then I dont have to worry about newly added dart sdk packages which again I will have to add in the command line. Only downside is you have organise your classes to be libraries for this to work. Otherwise you will to write down each and every I am not sure if this will be helpful, especially if the project is huge and has many packages. But still provides an idea of which one to generate docs for. Say if you want ignore docs for experimental libraries, which was my case. |
|
@Abhilash-Chandran thank you for the advice, not really actionable in my case (not going to change project structure to please the doc generator :)) but still valid in general. |
This was referenced Apr 14, 2020
|
Include dart:html, dart:js and dart:js_util
|
|
@rubensdemelo With dartdoc 0.30.4+ this should no longer be needed... are you still seeing the problem with the new version? |
|
@jcollins-g Im not sure how to update dartdoc. After run |
|
Maybe the If so, to force-run the one from pub, either use a path to that, or use |
|
@mit-mit sorry, but im still missing something... I change Dart SDK PATH, but still running 0.29.1 |
|
@rubensdemelo Your output doesn't specify which |
|
It works running Default path do dart-sdk:
Thank you all |
|
|
@mit-mit will this be solved with the future Dart command line tools? |
|
would be cool if there were a guide for windows as #1949 (comment) |
|
ok lol it's just as simple as https://stackoverflow.com/a/61260188/9710294 |
|
I'm getting this issue when running Dartdoc in a GitHub action. Here's the command that fails: flutter pub global run dartdoc
--exclude 'dart:async,dart:collection,dart:convert,dart:core,dart:developer,dart:io,dart:isolate,dart:math,dart:typed_data,dart:ui'
--show-progress
--output docs
--no-auto-include-dependencies
--no-validate-links
--no-verbose-warnings
--no-allow-non-local-warningsInterestingly enough, running that command locally didn't give the error. Here's the full output of the error: And yes, the weird non-ASCII characters did show in the GitHub logs, but not in my terminal. Any ideas what happened? |
|
Sorry if anyone is still experiencing issues. But there is a lot of history in this bug, and it's closed, so if anyone is still having issues, can you kindly open a new bug (with detailed repro steps)? |
|
Sure thing. I managed to "fix" it by including a long list of |
|
dartdoc failed: RangeError (index): Invalid value: Valid value range is empty: 0 I get this issue when running dartdoc |
|
@iamadeeb please file a new issue, incl. repro steps for that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Im generating a new doc for my package, following theses instructions: https://flutter.dev/docs/development/packages-and-plugins/developing-packages
When I run
dartdoc, it generates docs for my package and also to dart-sdk . How to avoid it ?Is that correct ?
The text was updated successfully, but these errors were encountered: