Skip to content

Display user-provided documentation link. #1225

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 24, 2018
Merged

Display user-provided documentation link. #1225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions app/lib/frontend/templates.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,14 @@ class TemplateService {
tabs.first['active'] = '-active';
}
final analysisStatus = analysis?.analysisStatus ?? extract?.analysisStatus;
String documentationUrl = selectedVersion.documentation;
if (documentationUrl != null &&
(documentationUrl.startsWith('https://www.dartdocs.org/') ||
documentationUrl.startsWith('http://www.dartdocs.org/') ||
documentationUrl.startsWith('https://pub.dartlang.org/') ||
documentationUrl.startsWith('http://pub.dartlang.org/'))) {
documentationUrl = null;
}

final values = {
'package': {
Expand All @@ -394,6 +402,7 @@ class TemplateService {
'authors_html':
_getAuthorsHtml(selectedVersion.pubspec.getAllAuthors()),
'homepage': selectedVersion.homepage,
'documentation': documentationUrl,
'dartdocs_url': selectedVersion.dartdocsUrl,
// TODO: make this 'Uploaders' if Package.uploaders is > 1?!
'uploaders_title': 'Uploader',
Expand Down
3 changes: 2 additions & 1 deletion app/test/frontend/golden/pkg_show_page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,8 @@ <h4>Dependencies</h4>
<h3 class="title">About</h3>
<p>my package description</p>
<p>
<a class="link" href="http://hans.juergen.com">Homepage</a>,
<a class="link" href="http://hans.juergen.com">Homepage</a><br/>

<a class="link" href="https://pub.dartlang.org/documentation/foobar_pkg/0.1.1+5/">API Docs</a>
</p>

Expand Down
3 changes: 2 additions & 1 deletion app/test/frontend/golden/pkg_show_page_discontinued.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,8 @@ <h2>Analysis</h2>
<h3 class="title">About</h3>
<p>my package description</p>
<p>
<a class="link" href="http://hans.juergen.com">Homepage</a>,
<a class="link" href="http://hans.juergen.com">Homepage</a><br/>

<a class="link" href="https://pub.dartlang.org/documentation/foobar_pkg/0.1.1+5/">API Docs</a>
</p>

Expand Down
3 changes: 2 additions & 1 deletion app/test/frontend/golden/pkg_show_page_flutter_plugin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,8 @@ <h4>Platforms</h4>
<h3 class="title">About</h3>
<p>my package description</p>
<p>
<a class="link" href="http://hans.juergen.com">Homepage</a>,
<a class="link" href="http://hans.juergen.com">Homepage</a><br/>

<a class="link" href="https://pub.dartlang.org/documentation/foobar_pkg/0.1.1+5/">API Docs</a>
</p>

Expand Down
3 changes: 2 additions & 1 deletion app/test/frontend/golden/pkg_show_page_outdated.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,8 @@ <h2>Analysis</h2>
<h3 class="title">About</h3>
<p>my package description</p>
<p>
<a class="link" href="http://hans.juergen.com">Homepage</a>,
<a class="link" href="http://hans.juergen.com">Homepage</a><br/>

<a class="link" href="https://pub.dartlang.org/documentation/foobar_pkg/0.1.1+5/">API Docs</a>
</p>

Expand Down
3 changes: 2 additions & 1 deletion app/test/frontend/golden/pkg_show_version_page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,8 @@ <h4>Dependencies</h4>
<h3 class="title">About</h3>
<p>my package description</p>
<p>
<a class="link" href="http://hans.juergen.com">Homepage</a>,
<a class="link" href="http://hans.juergen.com">Homepage</a><br/>

<a class="link" href="https://pub.dartlang.org/documentation/foobar_pkg/0.1.1+5/">API Docs</a>
</p>

Expand Down
3 changes: 2 additions & 1 deletion app/views/pkg/show.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ import 'package:{{package}}/{{library}}';
{{#package.description}}
<p>{{package.description}}</p>
<p>
{{#package.homepage}}<a class="link" href="{{& package.homepage}}">Homepage</a>,{{/package.homepage}}
{{#package.homepage}}<a class="link" href="{{& package.homepage}}">Homepage</a><br/>{{/package.homepage}}
{{#package.documentation}}<a class="link" href="{{& package.documentation}}">Documentation</a><br/>{{/package.documentation}}
<a class="link" href="{{& package.dartdocs_url}}">API Docs</a>
</p>
{{/package.description}}
Expand Down