From 0bf8ddd7c97b62e7237495d8a03f0114824ff197 Mon Sep 17 00:00:00 2001 From: facelessuser Date: Fri, 20 May 2022 20:00:38 -0600 Subject: [PATCH] Update copyright info and rework doc snippet linkage --- LICENSE.md | 2 +- README.md | 2 +- .../{_snippets/links.txt => .snippets/links.md} | 0 docs/src/markdown/about/changelog.md | 2 -- docs/src/markdown/about/contributing.md | 2 -- docs/src/markdown/about/license.md | 17 +---------------- docs/src/markdown/index.md | 2 -- docs/src/markdown/refs.md | 2 -- docs/src/markdown/usage.md | 2 -- mkdocs.yml | 6 +++++- 10 files changed, 8 insertions(+), 29 deletions(-) rename docs/src/markdown/{_snippets/links.txt => .snippets/links.md} (100%) diff --git a/LICENSE.md b/LICENSE.md index ea9c400..0c1b433 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 - 2021 Isaac Muse +Copyright (c) 2015 - 2022 Isaac Muse Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c0fcb61..1a456a6 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ https://facelessuser.github.io/backrefs/ Released under the MIT license. -Copyright (c) 2015 - 2021 Isaac Muse +Copyright (c) 2015 - 2022 Isaac Muse Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the diff --git a/docs/src/markdown/_snippets/links.txt b/docs/src/markdown/.snippets/links.md similarity index 100% rename from docs/src/markdown/_snippets/links.txt rename to docs/src/markdown/.snippets/links.md diff --git a/docs/src/markdown/about/changelog.md b/docs/src/markdown/about/changelog.md index e5df22a..cadf4f7 100644 --- a/docs/src/markdown/about/changelog.md +++ b/docs/src/markdown/about/changelog.md @@ -249,5 +249,3 @@ to work even when the Re or Regex API changes. Change was made to support new Re ## 1.0 - **NEW**: Initial release. - ---8<-- "links.txt" diff --git a/docs/src/markdown/about/contributing.md b/docs/src/markdown/about/contributing.md index d385f30..644d9a3 100644 --- a/docs/src/markdown/about/contributing.md +++ b/docs/src/markdown/about/contributing.md @@ -81,5 +81,3 @@ You don't have to render the docs locally before pull requesting, but if you wis [MkDocs][mkdocs], the [Material theme][mkdocs-material], and [PyMdown Extensions][pymdown-extensions] to render the docs. You can preview the docs if you install these two packages. The command for previewing the docs is `mkdocs serve` from the root directory. You can then view the documents at `localhost:8000`. - ---8<-- "links.txt" diff --git a/docs/src/markdown/about/license.md b/docs/src/markdown/about/license.md index a420cd0..5764960 100644 --- a/docs/src/markdown/about/license.md +++ b/docs/src/markdown/about/license.md @@ -1,18 +1,3 @@ # License -MIT license. - -Copyright (c) 2015 - 2021 Isaac Muse - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated -documentation files (the "Software"), to deal in the Software without restriction, including without limitation the -rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit -persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the -Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE -WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR -OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +--8<-- "LICENSE.md" diff --git a/docs/src/markdown/index.md b/docs/src/markdown/index.md index 38e2382..f7d2a40 100755 --- a/docs/src/markdown/index.md +++ b/docs/src/markdown/index.md @@ -39,5 +39,3 @@ There are a couple of recommended ways to install Backrefs. ``` This method will allow you to instantly see your changes without reinstalling which is great for developing. - ---8<-- "links.txt" diff --git a/docs/src/markdown/refs.md b/docs/src/markdown/refs.md index 39a5b91..e4017fb 100644 --- a/docs/src/markdown/refs.md +++ b/docs/src/markdown/refs.md @@ -311,5 +311,3 @@ In the table below, patterns with `--` mean `[[in this] -- [but not this]]`. `Upper` | `\p{Uppercase}` `Word` | `[\p{Alnum}\p{M}\p{Pc}\p{JoinControl}]` `XDigit` | `[\p{Nd}\p{HexDigit}]` - ---8<-- "links.txt" diff --git a/docs/src/markdown/usage.md b/docs/src/markdown/usage.md index d37dffa..d70f2d3 100755 --- a/docs/src/markdown/usage.md +++ b/docs/src/markdown/usage.md @@ -241,5 +241,3 @@ Pre-compiled pattern objects can also create a compiled format replace object us >>> pattern.subf(replace, "foo bar") 'Bar Foo' ``` - ---8<-- "links.txt" diff --git a/mkdocs.yml b/mkdocs.yml index 01f6283..67046a3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,7 +82,11 @@ markdown_extensions: - pymdownx.mark: - pymdownx.striphtml: - pymdownx.snippets: - base_path: docs/src/markdown/_snippets + base_path: + - docs/src/markdown/.snippets + - LICENSE.md + auto_append: + - links.md - pymdownx.keys: separator: "\uff0b" - pymdownx.details: