"""
The latest version of this package is available at:
<http://github.com/jantman/github-docs-index>
##################################################################################
Copyright 2018 Jason Antman <jason@jasonantman.com> <http://www.jasonantman.com>
This file is part of github-docs-index, also known as github-docs-index.
github-docs-index is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
github-docs-index is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with github-docs-index. If not, see <http://www.gnu.org/licenses/>.
The Copyright and Authors attributions contained herein may not be removed or
otherwise altered, except to add the Author attribution of a contributor to
this work. (Additional Terms pursuant to Section 7b of the AGPL v3)
##################################################################################
While not legally required, I sincerely request that anyone who finds
bugs please submit them at <https://github.com/jantman/github-docs-index> or
to me via email, and that you send any contributions or improvements
either as a pull request on GitHub, or to me via email.
##################################################################################
AUTHORS:
Jason Antman <jason@jasonantman.com> <http://www.jasonantman.com>
##################################################################################
"""
import logging
logger = logging.getLogger(__name__)
[docs]class QuickLink(object):
def __init__(self, title, url, description=None):
self._title = title
self._url = url
self._description = description
@property
def as_dict(self):
d = {'title': self._title, 'url': self._url}
if self._description is not None:
d['description'] = self._description
return d
@property
def rst_line(self):
r = '`%s <%s>`_' % (self._title, self._url)
if self._description is not None and self._description.strip() != '':
r += ' - ' + self._description
return r