diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..75dcf79
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,3 @@
+github: facelessuser
+custom:
+ - "https://www.paypal.me/facelessuser"
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index f4c3bb7..bdd7e08 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -16,7 +16,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v1
+ - uses: actions/checkout@v2
+ with:
+ fetch-depth: 0
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
with:
@@ -42,7 +44,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v1
+ - uses: actions/checkout@v2
- uses: actions/setup-python@v1
with:
python-version: 3.8
diff --git a/README.md b/README.md
index 680c3eb..1abd0d2 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
[![Donate via PayPal][donate-image]][donate-link]
[![Discord][discord-image]][discord-link]
[![Build][github-ci-image]][github-ci-link]
-[![Travis][travis-image]][travis-link]
[![Coverage Status][codecov-image]][codecov-link]
[![PyPI Version][pypi-image]][pypi-link]
[![PyPI - Python Version][python-image]][pypi-link]
@@ -47,11 +46,9 @@ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
[github-ci-image]: https://github.com/facelessuser/backrefs/workflows/build/badge.svg?branch=master&event=push
[github-ci-link]: https://github.com/facelessuser/backrefs/actions?query=workflow%3Abuild+branch%3Amaster
[discord-image]: https://img.shields.io/discord/678289859768745989?logo=discord&logoColor=aaaaaa&color=mediumpurple&labelColor=333333
-[discord-link]:https://discord.gg/MFfUFWC
+[discord-link]:https://discord.gg/TWs8Tgr
[codecov-image]: https://img.shields.io/codecov/c/github/facelessuser/backrefs/master.svg?logo=codecov&logoColor=aaaaaa&labelColor=333333
[codecov-link]: https://codecov.io/github/facelessuser/backrefs
-[travis-image]: https://img.shields.io/travis/facelessuser/backrefs/master.svg?label=travis&logo=travis%20ci&logoColor=aaaaaa&labelColor=333333
-[travis-link]: https://travis-ci.org/facelessuser/backrefs
[pypi-image]: https://img.shields.io/pypi/v/backrefs.svg?logo=pypi&logoColor=aaaaaa&labelColor=333333
[pypi-link]: https://pypi.python.org/pypi/backrefs
[python-image]: https://img.shields.io/pypi/pyversions/backrefs?logo=python&logoColor=aaaaaa&labelColor=333333
diff --git a/backrefs/__meta__.py b/backrefs/__meta__.py
index 93b5673..280234c 100644
--- a/backrefs/__meta__.py
+++ b/backrefs/__meta__.py
@@ -185,5 +185,5 @@ def parse_version(ver, pre=False):
return Version(major, minor, micro, release, pre, post, dev)
-__version_info__ = Version(4, 5, 0, ".dev")
+__version_info__ = Version(4, 5, 0, "final")
__version__ = __version_info__._get_canonical()
diff --git a/docs/src/markdown/changelog.md b/docs/src/markdown/about/changelog.md
similarity index 100%
rename from docs/src/markdown/changelog.md
rename to docs/src/markdown/about/changelog.md
diff --git a/docs/src/markdown/contributing.md b/docs/src/markdown/about/contributing.md
similarity index 86%
rename from docs/src/markdown/contributing.md
rename to docs/src/markdown/about/contributing.md
index 0c03752..704f3af 100644
--- a/docs/src/markdown/contributing.md
+++ b/docs/src/markdown/about/contributing.md
@@ -9,6 +9,17 @@ Contribution from the community is encouraged and can be done in a variety of wa
- Code patches via pull requests.
- Documentation improvements via pull requests.
+## Become a Sponsor :octicons-heart-fill-16:{: .heart-throb}
+
+Open source projects take time and money. Help support the project by becoming a sponsor. You can add your support at
+any tier you feel comfortable with. No amount is too little.
+
+:octicons-mark-github-16: [GitHub Sponsors ](https://github.com/sponsors/facelessuser)
+
+If you'd like to do a one time contribution, you can do so via PayPal.
+
+:fontawesome-brands-paypal: [PayPal](https://www.paypal.me/facelessuser)
+
## Bug Reports
1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
diff --git a/docs/src/markdown/license.md b/docs/src/markdown/about/license.md
similarity index 100%
rename from docs/src/markdown/license.md
rename to docs/src/markdown/about/license.md
diff --git a/docs/theme/announce.html b/docs/theme/announce.html
new file mode 100644
index 0000000..62749f7
--- /dev/null
+++ b/docs/theme/announce.html
@@ -0,0 +1,5 @@
+Sponsorship
+is now available!
+
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
index b1d9d65..169037d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -9,6 +9,7 @@ copyright: |
docs_dir: docs/src/markdown
theme:
name: material
+ custom_dir: docs/theme
icon:
logo: material/book-open-page-variant
palette:
@@ -17,13 +18,16 @@ theme:
font:
text: Roboto
code: Roboto Mono
+ features:
+ - tabs
nav:
- User Guide: index.md
- Installation: installation.md
- - Contributing & Support: contributing.md
- - Changelog: changelog.md
- - License: license.md
+ - About:
+ - Contributing & Support: about/contributing.md
+ - Changelog: about/changelog.md
+ - License: about/license.md
markdown_extensions:
- markdown.extensions.toc:
@@ -76,13 +80,14 @@ markdown_extensions:
separator: "\uff0b"
- pymdownx.details:
- pymdownx.tabbed:
+ - pymdownx.saneheaders:
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/facelessuser
- icon: fontawesome/brands/discord
- link: https://discord.gg/MFfUFWC
+ link: https://discord.gg/TWs8Tgr
plugins:
- search
diff --git a/requirements/docs.txt b/requirements/docs.txt
index b153107..e0507ff 100644
--- a/requirements/docs.txt
+++ b/requirements/docs.txt
@@ -1,4 +1,4 @@
-mkdocs_pymdownx_material_extras==1.0.1
+mkdocs_pymdownx_material_extras==1.0.7
mkdocs-git-revision-date-localized-plugin
mkdocs-minify-plugin
pyspelling