CODEWITHSUNDEEP
flutterdartdartdoc
Shahzad Akram
Shahzad Akram

Reputation: 5254

dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set

I am trying to run dartdoc for my flutter package but I am getting this,

dartdoc failed: Top level package requires Flutter but FLUTTER_ROOT environment variable not set.

How to add FLUTTER_ROOT environment variable as I have already added environment variable for Flutter SDK and that's working fine, I am just getting issue while running dartdoc. I am a Linux user.

Upvotes: 21

Views: 6879

Answers (2)

Wizz.Xu
Wizz.Xu

Reputation: 111

If you wish to generate API documentation locally on your development machine, use the following commands:

  1. Change directory to the location of your package:
cd ~/dev/mypackage
  1. Tell the documentation tool where the Flutter SDK is located (change the following commands to reflect where you placed it):
export FLUTTER_ROOT=~/dev/flutter  # on macOS or Linux  
set FLUTTER_ROOT=~/dev/flutter     # on Windows
  1. Run the dartdoc tool (included as part of the Flutter SDK), as follows:
$FLUTTER_ROOT/bin/cache/dart-sdk/bin/resources/dartdoc   # on macOS or Linux  
%FLUTTER_ROOT%\bin\cache\dart-sdk\bin\resources\dartdoc   # on Windows

link https://flutter.dev/docs/development/packages-and-plugins/developing-packages

Upvotes: 10

Qiong Wu
Qiong Wu

Reputation: 1585

try running flutter pub global run dartdoc:dartdoc instead

Upvotes: 19

Related Questions